Command reference
Look up framework CLI syntax, flags, file changes, and exit behavior.
Project lifecycle commands
| Syntax | Side effect / behavior | Output and exit |
|---|---|---|
tavo create app [dir] [--package-manager npm|pnpm|yarn|bun] | Creates a new application directory and starter files. It does not install dependencies. | Prints created files and next commands; exits non-zero when creation is rejected. |
tavo dev [--ssr] [--host <ip>|--network] | Starts the development server. --ssr enables request-time route rendering. | Keeps running until stopped; startup failure exits non-zero. |
tavo build [--report-json] [--max-first-load-js <size>] [--max-route-js <size>] | Writes client, server, manifest, generated type, and optional report output under .tavo. | Prints route output and budgets; compilation, prerender, or budget failure exits non-zero. |
tavo preview [--ssr] [--host <ip>|--network] | Serves the last production build without rebuilding application source. | Keeps running until stopped; missing or invalid build output fails startup. |
Inspection and validation commands
| Syntax | Behavior |
|---|---|
tavo routes [--json] | Reads the file-route tree and reports patterns, files, layouts, and parameters. |
tavo info [--json] | Reads project, package, pages, and CSS configuration. |
tavo inventory [--json] | Indexes pages, layouts, components, stores, actions, imports, and exports. |
tavo inspect <route|component|store|file|api> <target> --json | Returns focused source and metadata, including a content hash where available. |
tavo doctor [--json|--fix-dry-run|--fix] | Reports project-shape diagnostics. Only --fix writes low-risk repairs; --fix-dry-run previews them. |
tavo check [--json] | Runs project diagnostics and the package.json typecheck script when one exists. |
Human output is the default. JSON commands return a protocol envelope and still use a non-zero exit status when diagnostics contain an error. A caller must check both the exit status and the envelope instead of assuming parseable JSON means success.
Generation, change, and verification commands
| Syntax | Side effect / behavior | Safe-use note |
|---|---|---|
tavo generate <kind> <name> [options] | Writes convention-aware page, component, store, action, or layout files. Pages are functional by default; --typed-route opts into defineRoutePage. | Use --from-json <file> --dry-run for a batch plan, or --validate-spec before writing. |
tavo change --from-json <file> [--dry-run] | Applies a hash-guarded change plan transactionally and prints the receipt JSON to stdout. | Run the same plan with --dry-run, then redirect a successful real run to a receipt file. |
tavo verify [--files <list>|--receipt <file>] [--smoke] [--no-project-scripts] [--json] | Expands affected files, runs source diagnostics, optional static smoke checks, and plugin inspection. By default it also runs the project's typecheck script. | Use --no-project-scripts for restricted automation; verify the JSON response contains projectScripts: false. |
Monitoring command
| Syntax | Behavior | Default / next step |
|---|---|---|
tavo monitor [--url <origin>] [--token <token>] [--once] [--interval <ms>] [--json] | Requests the protected runtime monitor endpoint; it does not deploy or alter the application. | The default URL is http://127.0.0.1:4174 and the token may come from TAVO_MONITOR_TOKEN. |
Installed command inventory
This help snapshot comes from @tavojs/cli 1.0.3. Run npx tavo --help in your application to check the commands supported by its installed version. Use the guides above for complete files and examples to accompany this syntax reference.
texttavo CLI v1.0.3
Commands:
tavo create app [dir]
tavo dev [--ssr] [--host 0.0.0.0|--network]
tavo build
tavo preview [--ssr] [--host 0.0.0.0|--network]
tavo monitor [--url http://127.0.0.1:4174]
tavo routes [--json]
tavo info [--json]
tavo inventory [--json]
tavo doctor [--json]
tavo doctor --fix-dry-run [--json]
tavo check [--json]
tavo agent-context --json [--task <task>] [--target <name>] [--detail summary|full]
tavo inspect <route|component|store|file|api> <target> --json
tavo inspect plugins [--json]
tavo change --from-json <file> [--dry-run]
tavo change --from-stdin [--dry-run]
tavo verify [--no-project-scripts] [--json]
tavo verify --smoke --json
tavo verify --spec <file> --json
tavo generate page <name> [--loader] [--seo] [--typed-route]
tavo generate component <name> [--props]
tavo generate store <name> [--shape key,count]
tavo generate layout <name>
tavo generate 404
tavo generate error
tavo generate action <name>
tavo generate --from-json <file>
tavo generate --from-stdin
tavo generate --validate-spec <file>
Flags:
--force overwrite generated files when supported
--loader include a typed page loader in page generator output
--seo include Seo metadata in page generator output
--typed-route wrap a generated page with defineRoutePage(...)
--props include a typed props example in component generator output
--shape <keys> comma-separated store keys for store generator output
--from-json <file> generate from a JSON spec file
--from-stdin generate from JSON read on stdin
--validate-spec <file> validate a generator spec without writing files
--dry-run print a transactional generation plan without writing files
--fix-dry-run print suggested doctor fixes without editing files
--fix apply low-risk doctor fixes
--spec <file> include a generator spec in verify output
--task <task> select task-specific agent context
--detail <level> select summary or full agent context
--files <list> verify comma-separated changed files
--receipt <file> verify files listed by a change receipt
--smoke include lightweight route smoke checks in verify output
--no-project-scripts skip package scripts during restricted verification
--package-manager <pm> scaffold app using npm, pnpm, yarn, or bun
--report-json write .tavo/generated/build-report.json
--max-first-load-js <size> fail build when initial JS exceeds size (for example 150kb)
--max-route-js <size> fail build when route JS exceeds size (for example 40kb)
--prerender-styles <mode> choose inline or external styles for static pages
--once print one monitor snapshot and exit
--json print supported command output as JSON
--interval <ms> delay between monitor refreshes
--token <token> send a monitor authorization bearer token
--host <ip> bind dev/preview server to a host, e.g. 0.0.0.0 for LAN access
--network shortcut for --host 0.0.0.0
--debug show error stack traces
--help show this message
--version print CLI versionChoose human or JSON output
Default output is optimized for terminal reading. Use --json for automation, CI artifacts, or editor integrations. Commands that write files expose a dry-run or validation path when a safe preview is meaningful.
Use --help on the project-local version for exact installed behavior.
Use --json only on commands that advertise it.
Treat non-zero exit status as failure even when JSON contains useful diagnostics.
Persist build reports and change receipts when they are part of a CI or automation decision.