# DevForgeAI CLI Reference

> **Generated file.** Do NOT edit by hand. Regenerate via:
>
> ```bash
> npm run docs:cli-ref
> ```
>
> This file is committed and checked by the `CLI reference drift gate` step
> in `.github/workflows/installer-testing.yml`. Any commander definition change
> (`lib/cli.js` or `src/cli/commands/*.js`) requires regeneration.

**Package version:** `v3.0.0-beta.5 · beta · npm`

---

## `devforgeai`

DevForgeAI — Spec-Driven Development Framework

### Global options

| Flag | Description |
|---|---|
| `-v, --version` | Output the version number |
| `-h, --help` | Display help for command |

---

## `devforgeai check-updates [directory]`

Check for available DevForgeAI updates across channels

### Arguments

| Name | Required? | Description | Default |
|---|---|---|---|
| `directory` | Optional |  | — |

### Options

| Flag | Description | Default |
|---|---|---|
| `--silent` | Emit NDJSON events instead of formatted text (full impl Phase 9; Phase 8 minimal stub) | — |
| `--no-cache` | Force fresh registry/API queries (skip 24h cache) | — |
| `--include-prerelease` | Include pre-release tags when checking the stable channel | — |

---

## `devforgeai install [directory]`

Install DevForgeAI framework into a project

### Arguments

| Name | Required? | Description | Default |
|---|---|---|---|
| `directory` | Optional |  | — |

### Options

| Flag | Description | Default |
|---|---|---|
| `--silent` | Emit NDJSON event stream on stdout (CI mode) | — |
| `--interactive` | Force interactive mode even on no-TTY | — |
| `-y, --yes` | [DEPRECATED v4.0] Aliased to --silent | — |
| `-q, --quiet` | [DEPRECATED v4.0] Aliased to --output=text --verbose=0 | — |
| `--skip-python` | Skip Python CLI installation | — |
| `--skip-verify` | Skip the post-install SHA256 verification pass (#300) | — |
| `--target <dir>` | Named install target (alias for positional) | — |
| `--config-file <path>` | YAML user install config | — |
| `--project-name <name>` | Set project name (default: basename of target) | — |
| `--components <list>` | Comma-separated component IDs to install | — |
| `--exclude-components <list>` | Comma-separated component IDs to skip | — |
| `--dry-run` | Plan only; no disk mutation | — |
| `--resume` | Resume partial install from journal | — |
| `--rollback` | Reverse a completed install | — |
| `--verify` | Post-install SHA256 integrity check | — |
| `--continue-on-error` | Force continue on all component failures | — |
| `--auto-rollback` | Silent: automatically roll back a failed install (copy-fail → exit 7, verify-fail → exit 6); alias of --rollback-on-fail | — |
| `--rollback-on-fail` | Silent: alias of --auto-rollback — roll back when a component copy or post-install verification fails | — |
| `--review-plan` | Silent: emit preflight.summary event without blocking | — |
| `--force` | Force overwrite without confirmation | — |
| `--reinstall` | Clean reinstall: re-copy framework + prune stale .claude/ framework files (devforgeai/ untouched; requires --force in silent mode) | — |
| `--session <id>` | Session ID for --resume / --rollback (auto-discovers latest if omitted) | — |
| `--force-resume` | Override engine_version mismatch check on --resume (ADR-101 D10) | — |
| `--output <format>` | ndjson \| text (default: ndjson in silent, text otherwise) | — |
| `--check-updates` | Check for available updates before install; exits 12 if update available | — |
| `--channel <channel>` | Channel to record in manifest: stable \| beta \| edge (default: stable) | — |
| `--switch-channel <channel>` | Switch installed channel (orchestrates npm install -g + .venv rebuild) | — |
| `--include-prerelease` | Include pre-release tags when checking the stable channel | — |
| `--to-version <version>` | Pin a specific version regardless of channel (e.g. 3.0.5) | — |
| `--latest` | Target the @latest npm dist-tag (ignore current channel) | — |
| `--allow-downgrade` | Allow a downgrade in silent mode (required for backward version transitions) | — |
| `--no-cache` | Force fresh registry/API queries (skip 24h version cache) | — |

---

## `devforgeai status [directory]`

Show DevForgeAI installation status

### Arguments

| Name | Required? | Description | Default |
|---|---|---|---|
| `directory` | Optional |  | — |

### Options

| Flag | Description | Default |
|---|---|---|
| `--check-updates` | Report installed vs latest across channels; exits 12 if stale (ADR-105 D8) | — |
| `--sbom` | Emit Software Bill of Materials (Phase 9 partial scaffold per ADR-102 D11) | — |
| `--json` | Emit machine-readable JSON output (Phase 9 partial scaffold per ADR-102 D10) | — |
| `--no-cache` | Force fresh registry/API queries when used with --check-updates | — |
| `--silent` | Emit NDJSON event instead of formatted text (Phase 9 full impl) | — |

---

## `devforgeai uninstall [directory]`

Remove DevForgeAI framework from a project

### Arguments

| Name | Required? | Description | Default |
|---|---|---|---|
| `directory` | Optional |  | — |

### Options

| Flag | Description | Default |
|---|---|---|
| `-y, --yes` | Skip confirmation prompt | — |
| `--purge` | Also remove the Python virtual environment (.venv/) | — |

