Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

CLI

The amodal CLI is the primary interface for building, running, and deploying agents. Install it globally or use via npx:

npm install -g @amodal/cli
# or
npx amodal <command>

Commands

Project

CommandDescription
initScaffold a new agent project
devStart local dev server with hot reload
validateCheck config for errors
inspectShow compiled context with token counts
build-manifest-typesGenerate TypeScript types from manifest

Connections & Packages

CommandDescription
connectAdd a connection (plugin or custom)
syncSync API specs from remote sources
installInstall marketplace packages
uninstallRemove packages
listList installed items
updateUpdate packages
diffShow package changes
searchSearch the marketplace
publishPublish to the registry

Runtime

CommandDescription
chatInteractive terminal chat with your agent
serveRun from a snapshot file
test-queryFire a one-off query against the agent

Platform & Deployment

CommandDescription
deployDeploy to the platform
loginAuthenticate with the platform
linkLink local project to platform
statusShow deployment status
rollbackRevert to a previous deployment
deploymentsList deployments
promotePromote a snapshot to production
secretsManage encrypted secrets
dockerBuild a Docker image
auditView audit logs
automationsManage automation schedules

Testing & Evaluation

CommandDescription
evalRun evaluation suites
experimentCompare models, prompts, or configs
test-queryTest a single query

Authentication

The CLI resolves credentials in order:

  1. Command-line flags
  2. amodal.json platform field (from amodal link)
  3. ~/.amodalrc (from amodal login)
  4. Environment variables (PLATFORM_API_URL, PLATFORM_API_KEY)