CLI
The Hutly CLI (hutly) is a command-line interface for managing your Hutly organisation from the terminal and from CI/CD. It started as a tool for deploying workflows from YAML and now spans most of the platform: agents, knowledge bases, tools, skills, integrations, conversations, custom tables, artifacts, webhooks, schedules, and organisation settings.
Everything the CLI does is scoped to a single organisation and authenticated with an API key, so the same commands work interactively on your laptop or unattended in a pipeline.
Looking for the raw HTTP endpoints? See the API Reference. The CLI is a convenience layer over the same org-scoped API and uses the same API key.
Capability map
| Area | Commands | Page |
|---|---|---|
| Deploy & manage workflows | deploy, publish, list, get, delete, pull, validate, synthesize, beautify, workflow … |
Workflows |
| Author workflows in YAML | !include directives, file organisation |
YAML format |
| AI agents | agents, models |
Agents |
| Knowledge bases | kbs |
Knowledge Bases |
| Backend tools | tools |
Tools |
| Skills | skills, deploy-skill, validate-skill, track-skill |
Skills |
| Third-party integrations | integrations |
Integrations |
| Conversations & search | conversations, history |
Conversations & History |
| Custom tables | tables |
Custom Tables |
| Artifacts | artifact |
Artifacts |
| Canvas | canvas |
Canvas |
| Triggers & approvals | webhooks, schedules, manual-tasks |
Webhooks, Schedules & Tasks |
| Feed channels | channels |
Feed Channels |
| Organisation | org |
Organisation |
| Vault secrets | secret |
Secrets |
| Modules registry | modules |
Modules |
Quick start
# 1. Install (native binary, no Node runtime required to run hutly)
npm install -g @intellia/hutly-cli
# 2. Point the CLI at your org
export HUTLY_ORG_ID="your-org-id"
export HUTLY_API_KEY="your-api-key"
# 3. Deploy your first workflow
hutly workflow deploy ./workflows/my-workflow.yamlSee Installation and Configuration to get set up, then Workflows for the deployment flow.
Conventions
- JSON output — most commands accept
--json(the default for many) and--prettyfor indented output, so results pipe cleanly intojqand scripts. - Canonical command groups — workflow verbs live under
hutly workflow <verb>(aliashutly workflows). The historical top-level forms (hutly deploy,hutly list, …) remain as aliases. - Agent mode — set
HUTLY_AGENT_INVOCATION=1to run non-interactively; commands that would prompt instead fail fast with a documented exit code.