|
| 1 | +# CodeForge CLI |
| 2 | + |
| 3 | +CLI for CodeForge development workflows. Manages sessions, plugins, configuration, codebase indexing, and devcontainers. |
| 4 | + |
| 5 | +> **Experimental** — v0.1.0. Ships with CodeForge v2.1.1. |
| 6 | +
|
| 7 | +## Install |
| 8 | + |
| 9 | +```bash |
| 10 | +npm install -g codeforge-dev-cli |
| 11 | +``` |
| 12 | + |
| 13 | +Requires [Bun](https://bun.sh) runtime. |
| 14 | + |
| 15 | +## Usage |
| 16 | + |
| 17 | +```bash |
| 18 | +codeforge <command> [options] |
| 19 | +``` |
| 20 | + |
| 21 | +### Global Options |
| 22 | + |
| 23 | +| Flag | Description | |
| 24 | +|------|-------------| |
| 25 | +| `--local` | Run against the host filesystem (skip container proxy) | |
| 26 | +| `--container <name>` | Target a specific container by name | |
| 27 | + |
| 28 | +When run outside a devcontainer, commands auto-proxy into the running CodeForge container. Use `--local` to bypass. |
| 29 | + |
| 30 | +## Commands |
| 31 | + |
| 32 | +### `codeforge session` — Session History |
| 33 | + |
| 34 | +```bash |
| 35 | +codeforge session search "query" # Search session history |
| 36 | +codeforge session list # List recent sessions |
| 37 | +codeforge session show <id> # Show session details |
| 38 | +``` |
| 39 | + |
| 40 | +### `codeforge task` — Task Management |
| 41 | + |
| 42 | +```bash |
| 43 | +codeforge task search "query" # Search tasks across sessions |
| 44 | +codeforge task list # List tasks |
| 45 | +codeforge task show <id> # Show task details |
| 46 | +``` |
| 47 | + |
| 48 | +### `codeforge plan` — Plan Search |
| 49 | + |
| 50 | +```bash |
| 51 | +codeforge plan search "query" # Search plans across sessions |
| 52 | +``` |
| 53 | + |
| 54 | +### `codeforge plugin` — Plugin Management |
| 55 | + |
| 56 | +```bash |
| 57 | +codeforge plugin list # List installed plugins |
| 58 | +codeforge plugin show <name> # Show plugin details |
| 59 | +codeforge plugin enable <name> # Enable a plugin |
| 60 | +codeforge plugin disable <name> # Disable a plugin |
| 61 | +codeforge plugin hooks [name] # Show hooks (all or per-plugin) |
| 62 | +codeforge plugin agents [name] # Show agents (all or per-plugin) |
| 63 | +codeforge plugin skills [name] # Show skills (all or per-plugin) |
| 64 | +``` |
| 65 | + |
| 66 | +### `codeforge config` — Configuration |
| 67 | + |
| 68 | +```bash |
| 69 | +codeforge config show # Show current configuration |
| 70 | +codeforge config apply # Deploy config files to ~/.claude/ |
| 71 | +``` |
| 72 | + |
| 73 | +### `codeforge index` — Codebase Index |
| 74 | + |
| 75 | +```bash |
| 76 | +codeforge index build # Build symbol index for current project |
| 77 | +codeforge index search "query" # Search the symbol index |
| 78 | +codeforge index show <symbol> # Show symbol details |
| 79 | +codeforge index stats # Index statistics |
| 80 | +codeforge index tree # Symbol tree view |
| 81 | +codeforge index clean # Remove index data |
| 82 | +``` |
| 83 | + |
| 84 | +### `codeforge container` — Devcontainer Management |
| 85 | + |
| 86 | +These commands always run on the host (never proxied). |
| 87 | + |
| 88 | +```bash |
| 89 | +codeforge container up # Start the devcontainer |
| 90 | +codeforge container down # Stop the devcontainer |
| 91 | +codeforge container rebuild # Rebuild the devcontainer |
| 92 | +codeforge container exec <cmd> # Execute a command in the container |
| 93 | +codeforge container ls # List running containers |
| 94 | +codeforge container shell # Open a shell in the container |
| 95 | +``` |
| 96 | + |
| 97 | +## License |
| 98 | + |
| 99 | +GPL-3.0 — see [LICENSE](../LICENSE.txt). |
0 commit comments