Skip to content

CLI Commands

genaug is the single public General Augment CLI.

The dashboard and CLI operate the same Project desired state. CLI mutations produce immutable Candidate releases; the dashboard provides human review and Live authority.

Terminal window
genaug --help
genaug agent --help
genaug agent create --help
Option Behavior
--project Override repository and global Project context.
--plan Validate and show the semantic diff with no local or remote writes.
--draft Atomically update only the local genaug/v3 bundle.
--json Return stable, prompt-free machine output.
--wait Follow durable operation events to an actionable terminal state.

The default commits one immutable Candidate remotely, then writes the server-normalized source locally. The server rejects stale base revisions with a semantic conflict; it never applies last-write-wins.

genaug
├── auth login|logout|whoami
├── workspace create|list|use
│ └── member invite|list|update|remove
├── project create|list|show|use|update|export|transfer|delete
├── agent create|list|show|update|clone|delete|test
│ ├── soul show|set
│ ├── skill attach|detach
│ ├── capability grant|revoke
│ ├── memory grant|revoke
│ ├── model show|set
│ ├── limits show|set
│ ├── delegation add|list|remove
│ └── connect|disconnect
├── skill add|list|show|remove
├── capability import|register|list|show|test|remove
├── credential set|status|connect|rotate|remove
├── memory namespace create|list|update|remove
├── user list|show|link|unlink
│ └── memory list|search|correct|export|delete
├── connection list|show|test|disable
├── policy show|update
├── approval list|show|approve|deny|open
├── release plan|deploy|list|show|diff|promote|rollback
├── run list|show|watch|cancel|retry
├── job create|list|show|run|pause|resume|delete
├── eval create|list|run|show
├── usage show|export
├── budget show|set
├── audit list|export
├── key create|list|rotate|revoke
├── dashboard open
├── status
├── doctor
└── launch

There are no public plural aliases, top-level deploy/promote/rollback aliases, separate provider setup trees, or v1/v2 management commands.

Terminal window
genaug launch \
--app-root . \
--project-name "Commerce App" \
--project-slug commerce-app \
--issuer-url https://app.example.com \
--jwks-url https://app.example.com/.well-known/jwks.json \
--audience commerce-app \
--user-id-claim sub \
--callback-base-url https://app.example.com \
--env-file .env.local \
--wait

launch creates or links one Project, commits the identity and app-backend contract, provisions one shared Candidate runtime key, writes it directly to an ignored server environment file, and verifies the binding.

Terminal window
genaug capability import openapi orders \
--spec ./orders.openapi.json \
--operation listOrders=orders.read \
--credential orders-api
genaug capability import mcp analytics \
--url https://mcp.example.com/mcp \
--snapshot ./analytics-tools.json \
--tool query=analytics.query \
--credential analytics-oauth
genaug capability register orders.cancel \
--endpoint /api/genaug/tools/orders-cancel \
--method POST \
--input-schema ./schemas/cancel-order.json \
--risk write
genaug credential set orders-api --from-env ORDERS_API_KEY
genaug credential connect analytics-oauth
genaug credential rotate orders-api --from-stdin

OpenAPI and MCP discovery bytes are frozen as release assets. Agents grant individual capability names rather than an entire server. Secrets enter only through named environment variables, stdin, or browser OAuth.

Terminal window
genaug agent create support \
--purpose "Help signed-in customers manage their orders" \
--soul ./agents/support/SOUL.md \
--skill ./skills/order-support/SKILL.md \
--capability orders.read \
--memory user-memory:read-write \
--connection app-backend \
--wait

Each --skill .../SKILL.md captures the complete visible UTF-8 Skill directory. Supporting files are fingerprinted into the Candidate; hidden files are ignored and symbolic links are rejected. Candidate and Live Skill homes are immutable.

Another Agent reuses the same Project resources:

Terminal window
genaug agent create sales-assistant \
--purpose "Help customers choose products" \
--soul ./agents/sales/SOUL.md \
--skill ./skills/sales/SKILL.md \
--capability orders.read \
--memory user-memory:read \
--connection app-backend
Terminal window
genaug memory namespace create user-memory --scope user
genaug agent memory grant support user-memory --access read-write
genaug user link customer_123 --provider app --display-name "Customer 123"
genaug user memory search customer_123 "shipping preference"
genaug user memory correct customer_123 <memory-id> --content "Prefers pickup"
genaug user memory export customer_123 --output ./memory-export.json

User memory operations are directly audited and do not create a Candidate.

Terminal window
genaug agent connect support telegram --credential telegram-support-bot
genaug credential set telegram-support-bot --from-env TELEGRAM_BOT_TOKEN
genaug connection test telegram --wait
genaug agent connect support linq-imessage \
--credential linq-account \
--phone-number +14165550100

Connection declarations are desired state. Credential values and provider identifiers are observed operational bindings. General Augment provisions and probes real external state.

Terminal window
genaug agent test support --user customer_123 --json
genaug run show <run-id>
genaug run watch <run-id>
genaug release diff <release-id>
genaug dashboard open

Workspace owners/admins can promote from an interactive terminal:

Terminal window
genaug auth login
genaug release promote <release-id>
genaug release rollback

Promotion requires the complete release fingerprint. Unattended --json, service accounts, and API keys receive the dashboard review URL and cannot move Live.

Terminal window
genaug job create daily-summary \
--agent support \
--user customer_123 \
--prompt "Summarize open orders" \
--cron "0 9 * * *" \
--target live
genaug eval create ./evals/support.json
genaug eval run <suite-id> \
--target candidate \
--release-fingerprint <candidate-fingerprint> \
--wait

Jobs and hosted evals retain exact release authority. A stale eval fingerprint fails.

Terminal window
genaug usage show
genaug usage export --output ./usage.json
genaug budget set --project-daily 25 --project-monthly 500
genaug budget set --funding-mode byok
genaug audit export --output ./audit.json
genaug key create --target candidate --env-file .env.local
genaug key rotate --target candidate --env-file .env.local
genaug key revoke <key-id>

--funding-mode byok requires a matching active model-provider credential stored for the Project. free_sandbox, subscription_included, and prepaid_payg use General Augment’s provider account and charge the Project’s credit ledger.

Runtime key secrets are shown once or written directly to an ignored file. Local configuration stores only key identifiers, scopes, and targets.

Terminal window
genaug status --json
genaug doctor --json

Machine results include a version marker, stable reason codes, blockers, review URL, and next actions. They never include secret material or interactive prompts.