Ductape CLI
The Ductape CLI (@ductape/cli) lets you manage your Ductape workspace, applications, resources, and local projects directly from your terminal.
Install
Install the CLI globally:
npm install -g @ductape/cli
Verify the installation:
ductape --help
Quick reference
| Area | Commands |
|---|---|
| Auth | login, logout, whoami |
| Workspaces | workspaces list, workspaces use, workspaces current |
| Profiles | profiles list, profiles use local|cloud |
| Products | products list|get|create|update|delete |
| Apps | apps list|get|create|update|delete|import |
| Project | init, link, unlink |
| Local stack | install, start, stop, status |
| Resources | resources <type> <verb> |
| Cloud | cloud connections …, cloud resources … |
| Deploy | deploy releases …, deploy plans …, deploy deployments …, deploy builds …, deploy versions … (reference) |
| Database runtime | db connect, db query, db context |
| Database migrations | db schema generate, db migrate, db migrate status, db migrate rollback |
| Graph runtime | graph connect, graph query |
| Secrets | secrets create|list|get|update|delete, secrets-scan-env (save the secrets in a .env) |
| Generate | generate payload, generate snippet |
| Shell | completion bash|zsh |
SDK runtime defaults
Applications built with @ductape/sdk specify their product and environment when creating the SDK client.
The CLI uses the local project configuration stored in ductape/config.json, so you don't need to specify these values on every command.
See SDK runtime defaults for more information.
Documentation map
- Authentication — login, OAuth, and profiles
- Workspaces — listing and switching workspaces
- Project linking —
ductape/config.jsonandlink - Local platform — running the local Ductape platform
- Products — product management
- Apps — integration app management
- Resources — component CRUD operations
- Cloud — cloud connections and resources
- Database runtime & migrations — schema.json, migration files, apply and rollback
- Graph runtime — graph queries
- Secrets — workspace secrets
- Generate — payload and code generation
- Troubleshooting — common issues and fixes
API parity
The CLI and Workbench use the same backend APIs, ensuring that operations performed from the terminal behave consistently with the web interface.
CLI vs MCP Server
| CLI | MCP Server | |
|---|---|---|
| Authentication | User JWT + encrypted requests | publishable_key per request |
| Payload format | AES-encrypted | Plain JSON |
| Primary use case | Developers, CI/CD, local operations | AI agents with scoped access |