Skip to content
General Augment Docs

CLI Commands

Auth

Section titled “Auth”
Terminal window
genaug auth login --api-key gaadmlive_your_key_here
genaug auth whoami
genaug auth logout

Projects

Section titled “Projects”
Terminal window
genaug projects list
genaug projects create \
  --name "DayPlan Agent" \
  --slug dayplan-agent \
  --system-prompt "You help users plan calendar work."
genaug status --project dayplan-agent

API integration

Section titled “API integration”
Terminal window
genaug integrate https://api.example.com/openapi.json \
  --name dayplan-agent \
  --description "Calendar planning assistant"
genaug deploy ./dayplan-agent/genaug-agent.yaml
genaug tools list --project dayplan-agent
genaug tools toggle delete_account --project dayplan-agent --disable

Channels

Section titled “Channels”
Terminal window
genaug channels status --project dayplan-agent
genaug channels connect \
  --project dayplan-agent \
  --channel telegram \
  --bot-token "$TELEGRAM_BOT_TOKEN"

Local iteration

Section titled “Local iteration”
Terminal window
genaug dev ./dayplan-agent/genaug-agent.yaml --message "Help me plan tomorrow"

Logs

Section titled “Logs”
Terminal window
genaug logs --project dayplan-agent --follow

See the generated API reference for the HTTP contract behind these commands.