Skip to main content
The Kestrel CLI lets you manage workflows from your terminal. Use it for scripting, CI/CD integration, and day-to-day workflow management.

Installation

Homebrew (macOS / Linux)

Binary Download

Download the latest release from GitHub Releases:

Authentication

Create an Account

New to Kestrel? You can sign up directly from the terminal:
You’ll be prompted for a work email and password (8–30 characters, hidden input). If email verification is enabled on the server, a 6-character code is sent to your inbox — enter it at the prompt and you’re logged in automatically. You can also verify later:
Non-interactive usage (e.g. from a coding agent or script):
After verification the CLI saves your session to ~/.kestrel/config.json and prints suggested next steps (kestrel integrations connect ...). Create an API key in the Kestrel platform under Workflows > API Keys, then:

Email / Password

You’ll be prompted for your server URL, email, and password. Credentials are stored locally at ~/.kestrel/config.json.

Check Status

Log Out

Workflow Commands

List workflows

Aliases: kestrel wf list

Get workflow details

Shows the workflow definition, trigger config, and an ASCII diagram of the workflow DAG:

Create a workflow from file

Generate from natural language

Use the AI agent to generate a workflow from a description:
Add --save to immediately save as a draft:

Edit a workflow

Delete a workflow

Activate / Pause

Duplicate

Test a workflow

Run a dry-run execution:

Request a workflow

Submit a natural language request to trigger a matching workflow. This is the CLI equivalent of /kestrel-workflow in Slack or the “Make a Request” page in the Kestrel Platform UI:
If the matched workflow requires additional parameters, you’ll be prompted interactively:
If no workflow matches your request, the CLI asks whether you want to send it to your platform team as a workflow request (instead of filing one automatically):
Answering n (or pressing Enter) dismisses the request — it won’t appear in the platform’s Workflow Requests page.

Execution Commands

Statistics

Approval Commands

Version History & Rollback

Execution Replay

Replay failed executions from the beginning or from the failed step:

Request Commands

API Key Commands

Catalog and Integrations

Integration Commands

Connect, test, and disconnect integrations (cloud providers, CI/CD, databases, alerting, knowledge sources, and more) directly from the terminal. Aliases: kestrel integration, kestrel int.
Your API key needs the integrations:read and integrations:manage scopes to manage integrations. The key created during onboarding includes them by default.

List integrations

Shows every integration with its type and current connection status:

Connect an integration

Each integration has its own connect subcommand:
You can pass credentials as flags, but you don’t have to — running the bare command walks you through setup interactively:
  • The CLI prints setup instructions for the integration (where to create the API token, which permissions to grant, etc.), mirroring the platform UI.
  • It prompts for each required value. Secrets are read with hidden input — they never appear on the command line or in your shell history.
To see the flags and setup instructions for any integration:
Non-secret values can be passed as flags; file-based credentials support a --<flag>-file variant:

Connection types

Test a connection

Supported for token integrations and knowledge sources.

Disconnect an integration

OAuth, cluster, and cloud integrations must be disconnected in the Kestrel UI.