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 testing agents. Install it globally or use via npx:

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

Commands

Project

CommandDescription
initScaffold a new agent project
devStart local dev server with hot reload
validateCheck config and test live connections (--skip-test to disable)
inspectShow compiled context with token counts
build-manifest-typesGenerate TypeScript types from manifest

Packages (amodal pkg)

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

Deploy (amodal deploy)

CommandDescription
deploy pushDeploy to the platform
deploy buildBuild a deployment snapshot
deploy serveRun from a snapshot file
deploy statusShow deployment status
deploy listList deployments
deploy rollbackRoll back to a previous deployment
deploy promotePromote a deployment

Runtime

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

Testing & Evaluation

CommandDescription
evalRun evaluation suites
test-queryTest a single query

Ops (amodal ops)

CommandDescription
ops secretsManage secrets
ops dockerDocker image management
ops automationsManage automations
ops auditView audit logs
ops experimentCompare models, prompts, or configs

Auth (amodal auth)

CommandDescription
auth loginLog in to the platform
auth logoutLog out