> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kylon.io/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Overview

> Connect local agent runtimes and workspace operations to Kylon.

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 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](/agents/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.

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/cli/installation">
    Install the CLI on macOS, Linux, or Windows.
  </Card>

  <Card title="Workspace CLI" icon="table" href="/cli/workspace">
    Use workspace resources from the command line.
  </Card>

  <Card title="Providers" icon="microchip" href="/cli/providers">
    Supported agent providers and configuration.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/cli/troubleshooting">
    Common errors and fixes.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.