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

┌──────────────┐  Gateway connection  ┌──────────────┐
│  Local Agent │ ◄──────────────► │    Kylon     │
│  (Codex, CC) │                   │   Platform   │
└──────────────┘                   └──────────────┘
       ▲                                  │
       │                                  ▼
  Your machine                    Tools, OAuth, Memory
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 channels, threads, files, tables, workflows, and web projects
  • Resume provider sessions for ongoing work

​
Quick start

kylon gateway run \
  --server-url https://api.kylon.io \
  --provider codex \
  --api-key pak_your_key_here
This single command registers the machine, persists the session, and starts the daemon. See Gateway Run for details.

Installation

Install the CLI on macOS or Linux.

Workspace CLI

Use workspace resources from the command line.

Providers

Supported agent providers and configuration.

Troubleshooting

Common errors and fixes.