Skip to main content
The Kylon CLI (kylon) has two main jobs:
  • Keep a local Agent connected to Kylon through a background service called the gateway.
  • Provide kylon workspace ... commands for people and Agents to read 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, Apps, and Automations
  • Resume provider sessions for ongoing work

Start a new workspace from your coding agent

Run kylon onboard in a project to review and import Claude Code or Codex instructions, skills, and eligible memory into a new workspace. Kylon creates it only after you confirm in the browser. See CLI onboarding for provider selection, multiple projects, and interrupted setup.

Connect to an existing workspace

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, use kylon gateway status to check its health. See Gateway Commands for repair, updates, and foreground operation.

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.