uf CLI Reference
This page reflects
ufv0.12.0. Runuf --helpfor the latest.
Overview
uf [command] [flags]The uf CLI (alias for unbound-force) manages the full Unbound Force toolchain. Each command group handles a distinct concern — from project scaffolding to containerized development sessions.
Global flags:
| Flag | Description |
|---|---|
-h, --help | Help for any command |
-v, --version | Print the uf version |
init
Scaffold the Unbound Force specification framework into the current directory. Creates Speckit templates, scripts, OpenCode commands and agents, Divisor review personas, convention packs, and OpenSpec schema files.
User-owned files (templates, scripts, agents, config) are skipped if they already exist. Tool-owned files (Speckit commands, OpenSpec schema, convention packs) are updated if their content has changed.
uf init [flags]| Flag | Description |
|---|---|
--divisor | Deploy only Divisor review agents and convention packs |
--force | Overwrite all existing files |
--lang <string> | Project language for convention pack selection (auto-detected from go.mod, package.json, etc. if omitted) |
setup
Install and configure the Unbound Force development toolchain. Detects existing version and package managers, installs missing tools through the appropriate manager, configures the Swarm plugin in opencode.json, and scaffolds project files. Idempotent — safe to run multiple times.
uf setup [flags]| Flag | Description |
|---|---|
--dir <string> | Target directory for setup (default .) |
--dry-run | Print actions without executing |
--yes | Skip confirmation prompts for curl|bash installs |
See the
Quick Start for a walkthrough of uf setup.
doctor
Check for required tools, version managers, scaffolded files, hero availability, Swarm plugin status, MCP server configuration, and agent/skill integrity. Produces a colored terminal report by default, or structured JSON for CI pipelines.
Exit code 0 when all checks pass or only warnings exist. Exit code 1 when any check fails.
uf doctor [flags]| Flag | Description |
|---|---|
--dir <string> | Target directory to check (default .) |
--format <string> | Output format: text or json (default text) |
config
Manage the unified .uf/config.yaml configuration file.
uf config [command] [flags]Subcommands
| Subcommand | Description |
|---|---|
init | Create or update .uf/config.yaml |
show | Display effective configuration after all layers merge |
validate | Validate config file against known field values |
config init
uf config init [flags]| Flag | Description |
|---|---|
--dir <string> | Target directory (default .) |
config show
uf config show [flags]| Flag | Description |
|---|---|
--dir <string> | Target directory (default .) |
--format <string> | Output format: text or json (default text) |
config validate
uf config validate [flags]| Flag | Description |
|---|---|
--dir <string> | Target directory (default .) |
--format <string> | Output format: text or json (default text) |
sandbox
Launch, manage, and extract changes from containerized OpenCode development sessions. Supports Podman (local) and Eclipse Che / Dev Spaces (CDE) backends.
uf sandbox [command] [flags]Subcommands
| Subcommand | Description |
|---|---|
create | Provision a persistent sandbox workspace |
start | Launch or resume a sandbox |
stop | Stop a sandbox (preserves persistent state) |
attach | Connect to a running sandbox’s TUI |
extract | Extract changes from the sandbox as git patches |
status | Show sandbox workspace status |
destroy | Permanently delete a sandbox workspace |
gateway
Start a local reverse proxy that serves the Anthropic Messages API. The gateway auto-detects the cloud provider from environment variables and injects host-side credentials into upstream requests.
Supported providers:
- Anthropic (
ANTHROPIC_API_KEY) - Vertex AI (
CLAUDE_CODE_USE_VERTEX=1+ANTHROPIC_VERTEX_PROJECT_ID) - AWS Bedrock (
CLAUDE_CODE_USE_BEDROCK=1)
uf gateway [flags]| Flag | Description |
|---|---|
--detach | Run gateway in the background |
--port <int> | Port to listen on (default 53147) |
--provider <string> | Provider override: anthropic, vertex, or bedrock (auto-detected if omitted) |
Subcommands
| Subcommand | Description |
|---|---|
status | Show gateway status |
stop | Stop a running gateway |
See Also
- Quick Start – Install and verify the toolchain
- Developer Guide – Daily workflow with the
ufCLI - Common Workflows – End-to-end feature, bug fix, and review flows