---
summary: "Run the ACP bridge for IDE integrations"
read_when:
  - Setting up ACP-based IDE integrations
  - Debugging ACP session routing to the Gateway
title: "acp"
---

# acp

Run the ACP (Koi Client Protocol) bridge that talks to a SKYKOI Gateway.

This command speaks ACP over stdio for IDEs and forwards prompts to the Gateway
over WebSocket. It keeps ACP sessions mapped to Gateway session keys.

## Usage

```bash
SKYKOI acp

# Remote Gateway
SKYKOI acp --url wss://gateway-host:18789 --token <token>

# Attach to an existing session key
SKYKOI acp --session koi:main:main

# Attach by label (must already exist)
SKYKOI acp --session-label "support inbox"

# Reset the session key before the first prompt
SKYKOI acp --session koi:main:main --reset-session
```

## ACP client (debug)

Use the built-in ACP client to sanity-check the bridge without an IDE.
It spawns the ACP bridge and lets you type prompts interactively.

```bash
SKYKOI acp client

# Point the spawned bridge at a remote Gateway
SKYKOI acp client --server-args --url wss://gateway-host:18789 --token <token>

# Override the server command (default: SKYKOI)
SKYKOI acp client --server "node" --server-args SKYKOI.mjs acp --url ws://127.0.0.1:19001
```

## How to use this

Use ACP when an IDE (or other client) speaks Koi Client Protocol and you want
it to drive a SKYKOI Gateway session.

1. Ensure the Gateway is running (local or remote).
2. Configure the Gateway target (config or flags).
3. Point your IDE to run `SKYKOI acp` over stdio.

Example config (persisted):

```bash
SKYKOI config set gateway.remote.url wss://gateway-host:18789
SKYKOI config set gateway.remote.token <token>
```

Example direct run (no config write):

```bash
SKYKOI acp --url wss://gateway-host:18789 --token <token>
```

## Selecting kois

ACP does not pick kois directly. It routes by the Gateway session key.

Use koi-scoped session keys to target a specific koi:

```bash
SKYKOI acp --session koi:main:main
SKYKOI acp --session koi:design:main
SKYKOI acp --session koi:qa:bug-123
```

Each ACP session maps to a single Gateway session key. One koi can have many
sessions; ACP defaults to an isolated `acp:<uuid>` session unless you override
the key or label.

## Zed editor setup

Add a custom ACP koi in `~/.config/zed/settings.json` (or use Zed’s Settings UI):

```json
{
  "koi_servers": {
    "SKYKOI ACP": {
      "type": "custom",
      "command": "SKYKOI",
      "args": ["acp"],
      "env": {}
    }
  }
}
```

To target a specific Gateway or koi:

```json
{
  "koi_servers": {
    "SKYKOI ACP": {
      "type": "custom",
      "command": "SKYKOI",
      "args": [
        "acp",
        "--url",
        "wss://gateway-host:18789",
        "--token",
        "<token>",
        "--session",
        "koi:design:main"
      ],
      "env": {}
    }
  }
}
```

In Zed, open the Koi panel and select “SKYKOI ACP” to start a thread.

## Session mapping

By default, ACP sessions get an isolated Gateway session key with an `acp:` prefix.
To reuse a known session, pass a session key or label:

- `--session <key>`: use a specific Gateway session key.
- `--session-label <label>`: resolve an existing session by label.
- `--reset-session`: mint a fresh session id for that key (same key, new transcript).

If your ACP client supports metadata, you can override per session:

```json
{
  "_meta": {
    "sessionKey": "koi:main:main",
    "sessionLabel": "support inbox",
    "resetSession": true
  }
}
```

Learn more about session keys at [/concepts/session](/concepts/session).

## Options

- `--url <url>`: Gateway WebSocket URL (defaults to gateway.remote.url when configured).
- `--token <token>`: Gateway auth token.
- `--password <password>`: Gateway auth password.
- `--session <key>`: default session key.
- `--session-label <label>`: default session label to resolve.
- `--require-existing`: fail if the session key/label does not exist.
- `--reset-session`: reset the session key before first use.
- `--no-prefix-cwd`: do not prefix prompts with the working directory.
- `--verbose, -v`: verbose logging to stderr.

### `acp client` options

- `--cwd <dir>`: working directory for the ACP session.
- `--server <command>`: ACP server command (default: `SKYKOI`).
- `--server-args <args...>`: extra arguments passed to the ACP server.
- `--server-verbose`: enable verbose logging on the ACP server.
- `--verbose, -v`: verbose client logging.
