apunkt/ktx
1
0
Fork 0
mirror of https://github.com/Kaelio/ktx.git synced 2026-06-10 08:05:14 +02:00
Code Issues Projects Releases Packages Wiki Activity
ktx/docs-site/content/docs/integrations/agent-clients.mdx

147 lines
4.6 KiB
Text
Raw Permalink Normal View History

docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
---
title: Agent Clients
description: Set up KTX with Claude Code, Cursor, Codex, and OpenCode.
---
feat(cli)!: remove ktx agent command (#58) * feat(cli)!: remove ktx agent command * test(context): update PGlite boundary guardrail
2026-05-13 13:01:56 +02:00
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.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
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
feat(cli)!: remove ktx agent command (#58) * feat(cli)!: remove ktx agent command * test(context): update PGlite boundary guardrail
2026-05-13 13:01:56 +02:00
description: Use local KTX semantic context and wiki knowledge for this project.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
---
Available commands:
feat(cli)!: remove ktx agent command (#58) * feat(cli)!: remove ktx agent command * test(context): update PGlite boundary guardrail
2026-05-13 13:01:56 +02:00
- `ktx status --json --project-dir /path/to/project`
- `ktx sl list --json --project-dir /path/to/project`
feat(cli): clean up wiki and sl commands (#65) * feat(cli): clean up wiki and sl commands * test(scripts): update package artifact CLI smoke assertion
2026-05-13 15:41:10 +02:00
- `ktx sl search '<text>' --json --project-dir /path/to/project --connection-id '<id>'`
feat(cli)!: remove ktx agent command (#58) * feat(cli)!: remove ktx agent command * test(context): update PGlite boundary guardrail
2026-05-13 13:01:56 +02:00
- `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`
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
```
### Workflow tips
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
- 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.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
---
## 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
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
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.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
### Workflow tips
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
- Cursor rules in `.cursor/rules/` are automatically loaded into agent context.
- Project-scoped installs keep KTX command guidance close to the analytics context repository.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
---
## 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
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
Create `.agents/skills/ktx/SKILL.md` with the same content structure as Claude Code's `SKILL.md`.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
### Workflow tips
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
- 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.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
---
## 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
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
Create `.opencode/commands/ktx.md` with the same command definitions as Claude Code's `SKILL.md`.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
### Workflow tips
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
- OpenCode reads commands from `.opencode/commands/` on startup.
- Project-scoped only; use a shared repository template if multiple projects need identical command files.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
---
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
## Command reference
All supported agent clients call the same KTX CLI commands:
| Command | Description |
|---------|-------------|
feat(cli)!: remove ktx agent command (#58) * feat(cli)!: remove ktx agent command * test(context): update PGlite boundary guardrail
2026-05-13 13:01:56 +02:00
| `ktx status --json` | Return project setup and context readiness |
feat: rename project wiki directory (#66) * feat: rename project wiki directory * test: fix wiki skill ordering expectations * Show configured context sources in setup
2026-05-13 16:05:58 +02:00
| `ktx wiki search <query> --json` | Search wiki pages |
feat(cli)!: remove ktx agent command (#58) * feat(cli)!: remove ktx agent command * test(context): update PGlite boundary guardrail
2026-05-13 13:01:56 +02:00
| `ktx sl list --json` | List semantic-layer sources |
feat(cli): clean up wiki and sl commands (#65) * feat(cli): clean up wiki and sl commands * test(scripts): update package artifact CLI smoke assertion
2026-05-13 15:41:10 +02:00
| `ktx sl search <query> --json` | Search semantic-layer sources |
feat(cli)!: remove ktx agent command (#58) * feat(cli)!: remove ktx agent command * test(context): update PGlite boundary guardrail
2026-05-13 13:01:56 +02:00
| `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 |
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
### Security constraints
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
- Secrets and credentials are never exposed in command output.
- Commands resolve the project from `--project-dir`, `KTX_PROJECT_DIR`, or the nearest `ktx.yaml`.
docs: add title attributes to config code blocks Triggers VS Code tab styling on the docs' YAML/config blocks where surrounding prose names the file. Mechanical, ~1 edit across the guides section (building-context.mdx); primary-sources.mdx and context-sources.mdx already had title= on their Connection config blocks, so only the prose-named semantic source output example needed updating. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-11 00:45:43 -07:00
---
## Comparison
| | Claude Code | Cursor | Codex | OpenCode |
|---|---|---|---|---|
| CLI skills | Yes | Yes (.mdc) | Yes | Yes |
| Global install | Yes | No | Yes | No |
feat(cli): clean up command surface
2026-05-12 23:51:46 +02:00
| Config location | `.claude/skills/ktx/SKILL.md` | `.cursor/rules/ktx.mdc` | `.agents/skills/ktx/SKILL.md` | `.opencode/commands/ktx.md` |
Reference in a new issue Copy permalink