The sf command-line interface is the primary way to interact with Stoneforge. While agents use the CLI internally, human operators typically use the web dashboard — but the CLI is essential for setup, debugging, and scripting.
Global flags
These flags work with any sf command:
| Flag | Description |
|---|
--help, -h | Show help |
--version, -V | Show version |
--json | Output as JSON (machine-readable) |
--quiet, -q | Minimal output (IDs only) |
--verbose, -v | Enable debug output |
--actor <name> | Specify acting entity |
--from <name> | Alias for --actor |
--db <path> | Override database path |
--sign-key <key> | Private key for signing (base64 PKCS8) |
--sign-key-file <path> | Path to file containing private key |
Command aliases
Many commands have shorter aliases for convenience:
| Alias | Maps to |
|---|
add, new | create |
rm, remove | delete |
ls | list |
s, get | show |
todo, tasks | ready |
done, complete | close |
st | status |
dep | dependency |
msg | message |
doc | document |
All commands
| Command | Description |
|---|
sf init | Initialize a new workspace |
sf serve | Start server and web dashboard |
sf doctor | Check system health |
sf stats | Show workspace statistics |
sf completion | Generate shell completions |
sf migrate | Run database migrations |
sf reset | Reset workspace |
sf create | Create an element |
sf list | List elements |
sf show | Show element details |
sf update | Update an element |
sf delete | Soft-delete an element |
sf embeddings | Install, status, reindex, search embeddings |
sf export | Export data to JSONL |
sf import | Import data from JSONL |
sf status | Show sync status |
sf config | View and modify configuration |
sf identity | Identity and key management |
sf gc | Garbage collection |
sf history | View element event timeline |
sf install | Install Claude skills |
sf docs | Manage documentation library |
sf log | View operation log entries |
sf metrics | Show provider metrics and usage statistics |
| Command | Description |
|---|
sf task | Create, list, ready, blocked, backlog, assign, close, reopen, defer, describe |
sf dependency | Add, remove, list, tree |
sf plan | Create, list, show, activate, complete, cancel, manage tasks |
sf workflow | Create, list, show, tasks, progress, delete, promote, gc |
sf entity | Register, list, manage hierarchy |
sf document | Create, list, search, update, history, rollback, archive, reindex |
sf channel | Create, list, join, leave, members, merge |
sf message | Send, reply, list, thread |
sf inbox | View, read, archive notifications |
sf library | Create, list, manage documents and hierarchy |
sf team | Create, list, manage members |
sf playbook | List, show, validate, create |
| Command | Description |
|---|
sf agent | Register, start, stop, list, show, stream agents |
sf daemon | Start, stop, status, sleep, wake the dispatch daemon |
sf dispatch | Manually dispatch a task to an agent |
sf merge | Squash-merge a branch into the default branch |
sf pool | Create, list, show, update, delete, status, refresh pools |
sf task handoff | Hand off a task to another agent |
sf task complete | Complete a task with optional merge request |
sf task merge | Squash-merge a task branch and close |
sf task reject | Reject a task merge and reopen |
sf task sync | Sync task branch with main |
sf task merge-status | Update merge status |
