CLI Reference
The fyrn CLI is the primary interface for generating, testing, deploying, and monitoring integrations.
- Binary:
fyrn - NPM package:
@fyrn/cli - Node requirement:
>= 22.0.0
Installation
Section titled “Installation”npm install -g @fyrn/cliFor a deeper walkthrough with examples and CI/CD recipes, see the CLI Usage guide.
Command groups
Section titled “Command groups”| Group | Commands | Purpose |
|---|---|---|
| Project | init, pull, push, diff | Local project + remote flow sync |
| Auth | login, logout, auth status, auth api-key | Interactive + API-key authentication |
| Flows | flow list/show/create/deploy/test/preview/clone/diff/delete | Flow lifecycle |
| Connectors | connector list/catalog/instances/test/build/connect/status/token | Manage connector catalog + instances |
| Logs | logs tail/search/replay | Message log streaming and search |
| Schedules | schedules list/trigger | Scheduled flows |
| Adapters | adapters list/generate/test/templates | Custom-code adapters (V8 sandbox) |
| Lookup tables | lookup list/show/create/delete/set/remove/import/export | Account-scoped lookup tables |
| Bundles | bundle export/import | Portable flow bundles |
| Batch | batch submit/list/show/cancel/retry/errors | Bulk processing jobs |
| Self-healing | healing list/show/approve/reject | Auto-generated fixes |
| Governance | governance list/show/check (alias gov) | Policy checks |
| Agents | agents keys list/create/update/revoke, agents activity | AI agent keys + audit log |
| Published APIs | apis list/docs/spec/update/delete, apis services list/show/docs | Published APIs and service groups |
| Environments | env list/switch/current/create | Environment management |
| Accounts | accounts list/switch/current | Multi-account switching |
| Billing | billing status/upgrade/portal, usage, plan | Plan + usage |
Common flags
Section titled “Common flags”These flags apply to most subcommands where relevant:
| Flag | Description |
|---|---|
--env <name-or-slug> | Target environment (defaults to the active env) |
--help | Show help for the command |
--version | Show CLI version |
Interactive mode
Section titled “Interactive mode”Running fyrn with no arguments starts a conversational assistant backed by Claude. It can execute any CLI command with your permission and uses the same auth context as the CLI. Requires ANTHROPIC_API_KEY.
fyrnFull command reference
Section titled “Full command reference”See the CLI Usage guide for every command with flags, examples, and common workflows.