Reference
CLI
Commands for each stage of the local development and deployment workflow.
Last updated
On this page
Install the CLI
terminal
pip install connic-composer-sdk
connic --helpRun connic <command> --help for the complete options supported by the installed version.
The optional plugin prompt is interactive and never installs without confirmation. See Coding agent setup for the plugin, skill, and MCP paths.
Commands
| Command | Purpose |
|---|---|
| connic init [name] | Create a project; --skill also offers plugins for detected Codex and Claude Code clients. |
| connic skill | Install or update the project skill, then offer plugins for detected Codex and Claude Code clients. |
| connic update [--check|--sdk|--skill|--enable-reminders] | Check for or install SDK and skill updates, or enable update reminders. |
| connic login | Authenticate the CLI with a connic project. |
| connic migrate | Scan a supported LangChain or Google ADK project and generate a connic project. |
| connic dev | Choose a reusable named dev environment or a quick test with Up/Down and Enter. A reusable environment is selected by default; a valid saved preference comes first. |
| connic lint | Validate configuration, including connector files in connectors/ and test suites in tests/, and preview discovered agents and tools. |
| connic tools | List custom Python tools discovered in the current project and their signatures. |
| connic test | Run YAML test suites against the configured test environment. |
| connic deploy | Deploy a project without a connected Git repository; Git-connected projects deploy from their configured branch. Runs lint first and uploads connectors/ with the project. |
Common options
terminal
# Choose a dev environment interactively
connic dev
# Select a dev session directly
connic dev --quick
connic dev my-feature
# List deployment targets and deploy by name
connic deploy --list
connic deploy --env staging
# Deploy without prompts in CI
connic deploy --env staging --yes
connic test --env <environment-id>
# Narrow or automate test output
connic test --filter <case-name>
connic test --json
connic test --coverage
# Emergency deployment escape hatch
connic deploy --skip-testsBare connic deploy lists available environments by name. Use Up/Down to move and Enter to select an environment, then confirm before uploading. Environment IDs remain accepted by --env. See Dev Server for session behavior, Running Tests & CI for test exit codes, and Deployment for deployment workflows.