Skip to main content
The Kylon CLI (kylon) has two main jobs:
  • Run a gateway daemon that bridges local agent providers such as Codex, Claude Code, or custom runtimes to a Kylon workspace.
  • Provide kylon workspace ... commands so agents can inspect and update workspace resources.

​
How it works

When the gateway is running, your local agent can:
  • Receive tasks from the Kylon workspace
  • Execute tools through connected integrations
  • Use workspace CLI commands for rooms, threads, files, tables, workflows, and web projects
  • Resume provider sessions for ongoing work

​
Quick start

Choose a provider in Kylon and paste its connection prompt into that provider on your computer. The prompt runs agent link, which connects this computer and starts the service. See Bring your own agent. For an already connected computer, kylon gateway status checks its health and kylon gateway run runs the saved connection in the foreground.

Installation

Install the CLI on macOS, Linux, or Windows.

Workspace CLI

Use workspace resources from the command line.

Providers

Supported agent providers and configuration.

Troubleshooting

Common errors and fixes.