Skip to content

Commit 204bc6c

Browse files
authored
docs: surface seven-agent support above the fold (#42)
1 parent cb3be39 commit 204bc6c

1 file changed

Lines changed: 31 additions & 34 deletions

File tree

README.md

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,37 @@ transcript store, a vector database, or a hosted memory service. It does not req
2626
backend, a database, or a separate memory server. Node.js 18+, npm, and Git are all
2727
you need.
2828

29+
Works with any of the major coding agents you already use.
30+
31+
## Works with your coding agent
32+
33+
GraphKeeper ships first-class integrations for the coding agents below. If you use one
34+
of them, GraphKeeper works with it.
35+
36+
| Coding agent | Integration flag | Skill | Guidance | Invocation |
37+
|---|---|---|---|---|
38+
| Codex | `--integrate codex` | `.agents/skills/graphkeeper/SKILL.md` | `AGENTS.md` | `$graphkeeper` |
39+
| Claude Code | `--integrate claude` | `.claude/skills/graphkeeper/SKILL.md` | `CLAUDE.md` | `/graphkeeper` |
40+
| Cursor | `--integrate cursor` | `.cursor/skills/graphkeeper/SKILL.md` | `.cursor/rules/graphkeeper.md` | `@graphkeeper` |
41+
| OpenCode | `--integrate opencode` | `.opencode/skills/graphkeeper/SKILL.md` | `AGENTS.md` | `graphkeeper` |
42+
| Kilo Code | `--integrate kilo` | `.kilo/skills/graphkeeper/SKILL.md` | `.kilo/rules/graphkeeper.md` | `@graphkeeper` |
43+
| Windsurf | `--integrate windsurf` | `.windsurf/skills/graphkeeper/SKILL.md` | `.windsurf/rules/graphkeeper.md` | `@graphkeeper` |
44+
| Gemini CLI | `--integrate geminicli` | `.gemini/skills/graphkeeper/SKILL.md` | `GEMINI.md` | `@graphkeeper` |
45+
46+
Install any subset, or all of them at once:
47+
48+
```sh
49+
npx graphkeeper@latest init --integrate codex --integrate claude
50+
# Or install every registered adapter:
51+
npx graphkeeper@latest init --integrate all
52+
```
53+
54+
Each integration installs a canonical skill your agent invokes, plus a small reminder
55+
in the agent's guidance file. All skills are generated from one vendor-neutral
56+
`templates/SKILL.md`. Adapters that share a guidance file (Codex and OpenCode both use
57+
`AGENTS.md`) coexist: each owns one marked block, and your existing guidance outside
58+
that block is preserved.
59+
2960
## Why GraphKeeper
3061

3162
Without durable memory, a coding agent that investigated something in one session
@@ -84,40 +115,6 @@ The memory contract is deliberately small and explicit. An agent:
84115
GraphKeeper does not ingest conversations or decide what should become memory. The
85116
shipped agent skills give every supported agent the same explicit writing contract.
86117

87-
## Works with your coding agent
88-
89-
GraphKeeper ships first-class integrations for the agents below. If you use one of
90-
them, GraphKeeper works with it.
91-
92-
```text
93-
Codex · Claude Code · Cursor · OpenCode · Kilo Code · Windsurf · Gemini CLI
94-
```
95-
96-
Each integration installs a canonical skill your agent invokes, plus a small reminder
97-
in the agent's guidance file. All skills are generated from one vendor-neutral
98-
`templates/SKILL.md`.
99-
100-
| Coding agent | Integration flag | Skill | Guidance | Invocation |
101-
|---|---|---|---|---|
102-
| Codex | `--integrate codex` | `.agents/skills/graphkeeper/SKILL.md` | `AGENTS.md` | `$graphkeeper` |
103-
| Claude Code | `--integrate claude` | `.claude/skills/graphkeeper/SKILL.md` | `CLAUDE.md` | `/graphkeeper` |
104-
| Cursor | `--integrate cursor` | `.cursor/skills/graphkeeper/SKILL.md` | `.cursor/rules/graphkeeper.md` | `@graphkeeper` |
105-
| OpenCode | `--integrate opencode` | `.opencode/skills/graphkeeper/SKILL.md` | `AGENTS.md` | `graphkeeper` |
106-
| Kilo Code | `--integrate kilo` | `.kilo/skills/graphkeeper/SKILL.md` | `.kilo/rules/graphkeeper.md` | `@graphkeeper` |
107-
| Windsurf | `--integrate windsurf` | `.windsurf/skills/graphkeeper/SKILL.md` | `.windsurf/rules/graphkeeper.md` | `@graphkeeper` |
108-
| Gemini CLI | `--integrate geminicli` | `.gemini/skills/graphkeeper/SKILL.md` | `GEMINI.md` | `@graphkeeper` |
109-
110-
Install any subset, or all of them at once:
111-
112-
```sh
113-
npx graphkeeper@latest init --integrate codex --integrate claude
114-
# Or install every registered adapter:
115-
npx graphkeeper@latest init --integrate all
116-
```
117-
118-
Adapters that share a guidance file (Codex and OpenCode both use `AGENTS.md`) coexist:
119-
each owns one marked block, and your existing guidance outside that block is preserved.
120-
121118
## Two-minute quickstart
122119

123120
Prerequisites: **Node.js 18+**, **npm**, and **Git**. Supported on Linux, macOS,

0 commit comments

Comments
 (0)