CLI Reference

The jetic binary is your entry point into the whole runtime. This page documents the commands that ship today.

At a glanceCopy Anchor Link

jetic initCopy Anchor Link

Initializes a .jetic/ directory in the current project. No provider or API key setup is required.

jetic init

Creates jetic.config.json (if absent), the .jetic/ workspace, and an empty .jetic/model.json.

jetic scanCopy Anchor Link

Parses backend source code (via tsconfig.json and AST resolution), extracts routes, and writes .jetic/model.json.

jetic scan

It flattens nested Express router chains (e.g. app.use('/api/orders', ordersRouter) → router.post('/checkout')), records path parameters, recognizable auth middleware, and the exact source file and line for each route.

jetic inspectCopy Anchor Link

Displays summary metrics, or deep-inspects a single endpoint.

# Project summary: endpoint count, method breakdown, security rules
jetic inspect

# One endpoint, with source provenance, parameters and response schema
jetic inspect endpoint GET /api/orders/:id

jetic modelCopy Anchor Link

Inspects the behavioral model, or exports it to the split YAML layout.

# List endpoints (YAML layout if present, otherwise model.json)
jetic model list

# Export model.json -> api.yaml + paths/*.yaml + security/*.yaml
jetic model export --yaml

model.json remains the primary read/write format for the scanner, MCP server, and Jetic Studio. YAML export is opt-in.

jetic adapterCopy Anchor Link

Lists and inspects framework scanner adapters that implement the @jetic/scanner-sdk contract.

# List registered adapters and whether they are detected in this project
jetic adapter list

# Show detection result and a scan summary for one adapter
jetic adapter inspect express

jetic agentCopy Anchor Link

Runs deterministic Jetic agents — no LLM involved — that reason over the model, the change log, and workflows. Reports are written to .jetic/runs/<runId>/agent-report.json.

# List available agents
jetic agent list

# Detect endpoints added/removed since the last snapshot
jetic agent run model-watcher

# List workflows affected by recently changed source files
jetic agent run workflow-impact

jetic doctorCopy Anchor Link

Diagnoses common setup problems.

jetic doctor

Checks the Node version, jetic.config.json presence, adapter detection, model validity, workflow validity, and whether the jetic dev port is available.

jetic activityCopy Anchor Link

Lists the activity stream of endpoint additions/removals detected by jetic scan, written to .jetic/activity/activity.ndjson.

jetic activity list

jetic simulate endpointCopy Anchor Link

Simulates single endpoints or the entire model against a target environment, using generated data.

# Simulate every endpoint in model.json
jetic simulate endpoint --all

# Simulate one endpoint with detailed response logs
jetic simulate endpoint POST /api/auth/login --verbose

# Target a specific environment defined in model.json
jetic simulate endpoint --all --env staging

jetic simulate workflowCopy Anchor Link

Executes a saved multi-step workflow with automatic state capture and header injection.

# List all saved workflows in .jetic/workflows/
jetic simulate workflow --list

# Execute an existing workflow file
jetic simulate workflow --workflow .jetic/workflows/user-onboarding.json

# Clear runtime memory before executing
jetic simulate workflow --workflow .jetic/workflows/user-onboarding.json --clear-memory

See Workflows for the full authoring model.

jetic devCopy Anchor Link

Starts the Jetic Studio backend and serves the local web dashboard.

# Default port 8787
jetic dev

# Custom port
jetic dev --port 9000

jetic memoryCopy Anchor Link

Views and manages key-value entries stored in .jetic/memory.json.

# List all stored keys and values across scopes
jetic memory list

# Get a value (supports scope:key)
jetic memory get workflow:accessToken

# Set a value
jetic memory set workflow:accessToken "eyJhbGciOi..."

# Delete a key
jetic memory delete workflow:accessToken

# Clear all entries
jetic memory clear

jetic mcpCopy Anchor Link

Launches the Jetic MCP server over stdio, giving your editor's AI assistant typed tools to inspect, author, validate, and live-test endpoints and workflows. No AI key is needed — the editor's own model is used.

# Launch over stdio (uses the current directory as the project root)
jetic mcp

# Pin to a project explicitly (same as the JETIC_PROJECT_PATH env var)
jetic mcp --project C:/path/to/your-backend

See AI IDE Integration for per-editor configuration.

jetic configCopy Anchor Link

Displays the current project root and Jetic directory. Provider and API-key configuration is not supported.

jetic config list

jetic upgradeCopy Anchor Link

Checks for updates and upgrades Jetic dependencies across the workspace.

jetic upgrade

Environment variablesCopy Anchor Link