Documentation / Reference
CLI command reference
Local authoring, local HTTPS endpoints, offline documentation, profile authentication and Controller operation commands.
Command groups
| Group | Commands | Purpose |
|---|---|---|
| Local authoring, Studio & HTTPS server | studio (aliases app, shell), init, example, doctor, validate, dev, run, test, profile, deploy --local, ui, inspect, generate | Launch Rippflow Studio, scaffold projects, validate contracts, run and profile workflows, serve local HTTPS endpoints with callbacks, and inspect structured reports. |
| Offline docs & workspace search | docs info, docs skill --init, search_docs, vector_search_docs, get_doc, get_docs, project_files, search_project | Query the embedded documentation snapshot, inspect workspace files, and initialize coding-agent skills offline. |
| Profile & auth | setup, login, logout, profiles, auth, whoami | Configure named Controller profiles, manage tokens, and verify caller identity. |
| Controller & deployments | deploy, deployments, versions, activate, rollback, executions, cells, controls, tools, mcp, operations, rbac, releases, installation | Publish workflows, manage active versions, inspect runs, govern tools, and operate cells. |
See CLI & version compatibility for the full command-family matrix and Local HTTPS & Callbacks for wire contracts.
Common invocations
shell
# Launch Rippflow Studio & 4-command local developer journey: init -> validate -> dev -> deploy --local
rippflow studio
rippflow init my-app --lang python
cd my-app
rippflow validate rippflow.yaml --json
rippflow dev --input input.json --timeout-seconds 120 --report .outputs/dev-run.json
rippflow deploy --local --port 8443 --json
# Start a local HTTPS workflow run and inspect saved results
curl -sk -X POST https://localhost:8443/v1/workflows/my-app/run \
-H "Authorization: Bearer $DEPLOY_TOKEN" -H "Content-Type: application/json" -d @input.json
curl -sk https://localhost:8443/v1/runs/latest -H "Authorization: Bearer $DEPLOY_TOKEN"
curl -sk https://localhost:8443/v1/runs/<runId> -H "Authorization: Bearer $DEPLOY_TOKEN"
rippflow deploy --local --status --json
rippflow deploy --local --stop
# Resource profiling, report inspection & offline agent skill
rippflow test --project rippflow.yaml --profile --json
rippflow inspect --report .outputs/last-run.json --json
rippflow docs info --json
rippflow docs skill --init
rippflow search_docs "fan_in_all" --limit 5 --json
# Profile authentication, machine token exchange, scoped deployment & run submission
rippflow whoami --json
rippflow auth machine-token --installation-url https://controller.example.com --client-id ci-deployer --private-key-file ./ci-ed25519.pem --json
rippflow deploy workflow.yaml --tenant finance --namespace recon --bindings bindings.json --json
rippflow deployments run "$DEPLOYMENT_ID" --execution-id run-001 --input input.json --json
rippflow deployments execution "$DEPLOYMENT_ID" --execution-id run-001 --json
rippflow executions list --limit 10 --jsonPass --json for deterministic machine-readable output in CI/CD pipelines and coding agents.
Verified sources
Checked 2026-11-05.
- CLI command dispatcher 7f5ea32 · main
- Local HTTPS deployment and results server 7f5ea32 · main
- Controller and deployment routes 7f5ea32 · main
- Offline documentation commands 7f5ea32 · main
- Frozen installation compatibility 7f5ea32 · main