Ferrite Docs

CLI Commands

Find the Ferrite CLI command for creating, verifying, running, deploying, and operating an application.

View as Markdown

The ferrite CLI covers the complete application lifecycle. Run ferrite <command> --help for flags and argument order supported by your installed version.

Create and compose

CommandResult
ferrite new webapp <name> --with-testsCreate a content, API, and SSE application with tests.
ferrite new hello <name>Create a compact request/reply API.
ferrite add <package>Vendor a source package and its dependencies into the app.
ferrite auth <command>Install, configure, enable, disable, or diagnose Ferrite Auth.

Verify and develop

CommandResult
ferrite validate --spec ferrite.json --jsonValidate the manifest without compiling.
ferrite check --jsonRun admission, manifest, and Rust checks.
ferrite explain <code>Explain one admission or manifest error code.
ferrite testRun the app test suite locally.
ferrite test --remoteRun tests through Ferrite Cloud.
ferrite devStart the local planes, app process, gateway, and live reload.
ferrite dev --instances 3Run competing app instances against the same local state.
ferrite dev --chaos 5Kill and restart the app to exercise redelivery.
ferrite dev --jsonEmit lifecycle events as JSON Lines.

Deploy and release

CommandResult
ferrite previewDeploy the committed revision to an isolated, auto-expiring URL without the production gate.
ferrite deploySubmit source through admission and the attested build, then return the deployed host.
ferrite status <app>Read desired and running instance state.
ferrite logs <app>Read recent stdout and stderr.
ferrite rcs <command>Clone, inspect, commit, push, branch, merge, or land hosted source.

Operate

CommandResult
ferrite login --ephemeralCreate and store a capped testbed account.
ferrite login --endpoint <url> --token <token>Store an issued endpoint and bearer token.
ferrite accountRead the authenticated account and balance.
ferrite mcp-serveExpose the local development workflow to an MCP client over stdio.

App inventory, scaling, domains, secrets, usage, releases, environment promotion, notifications, rollback, and withdrawal are available in the Ferrite Dashboard and Ferrite MCP.

Account and agent access

Use ferrite login and ferrite account for local cloud credentials. ferrite mcp-serve exposes the local development workflow over stdio. Hosted source operations are available under ferrite rcs.

Continue with Ferrite CLI for the development loop or Deployments for release behavior.