---
title: Agent Clients
description: Set up KTX with Claude Code, Cursor, Codex, and OpenCode.
---

KTX integrates with coding agents through CLI skills and command files. These
files teach agents to call public `ktx` commands directly from the terminal for
semantic-layer context and wiki knowledge.

Run `ktx setup` and select your agent targets, or configure manually using the snippets below.

## Claude Code

### Install via `ktx setup`

During setup, select **Claude Code** from the agent targets. KTX writes:

| Mode | File |
|------|------|
| CLI skills | `.claude/skills/ktx/SKILL.md` |

Both project-scoped and global installations are supported. Global installs write to `~/.claude/skills/ktx/SKILL.md`.

### Manual CLI skills configuration

Create `.claude/skills/ktx/SKILL.md`:

```markdown title=".claude/skills/ktx/SKILL.md"
---
name: ktx
description: Use local KTX semantic context and wiki knowledge for this project.
---

Available commands:
- `ktx status --json --project-dir /path/to/project`
- `ktx sl list --json --project-dir /path/to/project`
- `ktx sl list --json --project-dir /path/to/project --query '<text>'`
- `ktx sl read '<sourceName>' --json --project-dir /path/to/project --connection-id '<id>'`
- `ktx sl query --json --project-dir /path/to/project --connection-id '<id>' --query-file '<path>' --execute --max-rows 100`
- `ktx wiki search '<query>' --json --project-dir /path/to/project --limit 10`
- `ktx wiki read '<pageId>' --json --project-dir /path/to/project`
```

### Workflow tips

- Claude Code discovers skills automatically from `.claude/skills/`.
- Global installation makes KTX available in all projects without per-project setup.
- Keep generated skills committed only when your team wants project-local agent instructions in git.

---

## Cursor

### Install via `ktx setup`

During setup, select **Cursor** from the agent targets. KTX writes:

| Mode | File |
|------|------|
| CLI rules | `.cursor/rules/ktx.mdc` |

Cursor supports project-scoped installation only.

### Manual CLI rules configuration

Create `.cursor/rules/ktx.mdc` with the same content structure as the Claude Code `SKILL.md` file. Cursor rules use the `.mdc` extension but support the same markdown command definitions.

### Workflow tips

- Cursor rules in `.cursor/rules/` are automatically loaded into agent context.
- Project-scoped installs keep KTX command guidance close to the analytics context repository.

---

## Codex

### Install via `ktx setup`

During setup, select **Codex** from the agent targets. KTX writes:

| Mode | File |
|------|------|
| CLI skills | `.agents/skills/ktx/SKILL.md` |

Both project-scoped and global installations are supported. Global installs write to `$CODEX_HOME/skills/ktx/SKILL.md` (defaults to `~/.codex/skills/ktx/SKILL.md`).

### Manual CLI skills configuration

Create `.agents/skills/ktx/SKILL.md` with the same content structure as Claude Code's `SKILL.md`.

### Workflow tips

- Set `CODEX_HOME` to customize the global installation directory.
- Codex shares the `.agents/` directory structure with the universal format.
- Global installation makes KTX available across all Codex sessions.

---

## OpenCode

### Install via `ktx setup`

During setup, select **OpenCode** from the agent targets. KTX writes:

| Mode | File |
|------|------|
| CLI commands | `.opencode/commands/ktx.md` |

OpenCode supports project-scoped installation only.

### Manual CLI commands configuration

Create `.opencode/commands/ktx.md` with the same command definitions as Claude Code's `SKILL.md`.

### Workflow tips

- OpenCode reads commands from `.opencode/commands/` on startup.
- Project-scoped only; use a shared repository template if multiple projects need identical command files.

---

## Command reference

All supported agent clients call the same KTX CLI commands:

| Command | Description |
|---------|-------------|
| `ktx status --json` | Return project setup and context readiness |
| `ktx wiki search <query> --json` | Search wiki pages |
| `ktx wiki read <key> --json` | Read a wiki page |
| `ktx wiki write <key>` | Write or update a wiki page |
| `ktx sl list --json` | List semantic-layer sources |
| `ktx sl list --query <text> --json` | Search semantic-layer sources |
| `ktx sl read <source> --json --connection-id <id>` | Read a semantic source definition |
| `ktx sl write <source> --connection-id <id>` | Write or update a semantic source |
| `ktx sl validate <source> --connection-id <id>` | Validate semantic source definitions |
| `ktx sl query --json` | Execute a semantic-layer query when semantic compute is configured |

### Security constraints

- Secrets and credentials are never exposed in command output.
- Commands resolve the project from `--project-dir`, `KTX_PROJECT_DIR`, or the nearest `ktx.yaml`.

---

## Comparison

| | Claude Code | Cursor | Codex | OpenCode |
|---|---|---|---|---|
| CLI skills | Yes | Yes (.mdc) | Yes | Yes |
| Global install | Yes | No | Yes | No |
| Config location | `.claude/skills/ktx/SKILL.md` | `.cursor/rules/ktx.mdc` | `.agents/skills/ktx/SKILL.md` | `.opencode/commands/ktx.md` |
