context-eng 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,11 +4,20 @@ Local project memory router for Codex and Claude Code. Memories live in one SQLi
|
|
|
4
4
|
|
|
5
5
|
## Use
|
|
6
6
|
|
|
7
|
-
Node.js 20 or newer.
|
|
7
|
+
- Requires Node.js 20 or newer.
|
|
8
|
+
- Run the command from within your project repository, not from your home directory.
|
|
8
9
|
|
|
9
10
|
```bash
|
|
10
11
|
npx -y context-eng init
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
```bash
|
|
11
15
|
pnpm dlx context-eng init
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
To set up a different folder than the one you are in:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
12
21
|
context-eng init --project /path/to/repo
|
|
13
22
|
```
|
|
14
23
|
|
|
@@ -28,16 +37,20 @@ flowchart TD
|
|
|
28
37
|
pick --> codex["~/.codex/config.toml"]
|
|
29
38
|
```
|
|
30
39
|
|
|
40
|
+
|
|
41
|
+
|
|
31
42
|
You do not start the server yourself. Cursor, Claude Code, or Codex runs `context-eng mcp`. With no `--project`, the server is global until a tool passes `projectPath` or calls `memory_bind`.
|
|
32
43
|
|
|
33
44
|
### Project and global
|
|
34
45
|
|
|
35
46
|
Two different splits:
|
|
36
47
|
|
|
37
|
-
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
|
|
|
48
|
+
|
|
49
|
+
| | Project | Global |
|
|
50
|
+
| ------------ | -------------------------------------------- | ------------------------------------------------ |
|
|
51
|
+
| Memory | This repo only, under `~/.context/projects/` | Every repo, under `~/.context/global/` |
|
|
52
|
+
| Instructions | Files inside the repo | Files in your home directory, used by every repo |
|
|
53
|
+
|
|
41
54
|
|
|
42
55
|
`memory_search` with `filters.scope` `project`, `global`, or `both` chooses the memory side. The files below are the instruction side.
|
|
43
56
|
|
|
@@ -45,16 +58,18 @@ Two different splits:
|
|
|
45
58
|
|
|
46
59
|
Instruction files (`AGENTS.md`, `CLAUDE.md`, and the rule files below) keep your other text. `init` replaces only the block between `<!-- context-eng:start -->` and `<!-- context-eng:end -->`. The MCP config files are updated in place and keep other servers.
|
|
47
60
|
|
|
48
|
-
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
|
|
|
52
|
-
| `<project>/
|
|
53
|
-
|
|
|
54
|
-
| `~/.
|
|
55
|
-
| `~/.
|
|
56
|
-
| `~/.
|
|
57
|
-
| `~/.
|
|
61
|
+
|
|
62
|
+
| File | When | What it does |
|
|
63
|
+
| ---------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
64
|
+
| OS keychain `context-eng` / `typesafe-api-key` | Always | Stores the TypeSafe key for this login |
|
|
65
|
+
| `<project>/AGENTS.md` | Only if that file already exists | Tells Codex, in this repo, to use the memory tools |
|
|
66
|
+
| `<project>/CLAUDE.md` | Only if that file already exists | Tells Claude Code, in this repo, to use the memory tools |
|
|
67
|
+
| `~/.codex/AGENTS.md` | Terminal or `--yes` | Same instructions for every Codex session |
|
|
68
|
+
| `~/.claude/CLAUDE.md` | Claude server added or already matching, or `--claude-only` | Same instructions for every Claude Code project |
|
|
69
|
+
| `~/.cursor/mcp.json` | Cursor selected | Starts the server for every Cursor project. No `--project` |
|
|
70
|
+
| `~/.claude.json` | Claude selected | Same for every Claude Code project. This is the file `claude mcp add --scope user` writes |
|
|
71
|
+
| `~/.codex/config.toml` | Codex selected | Adds `[mcp_servers.context-eng]` only. Codex may later add `[mcp_servers.context-eng.tools.*]` approval lines itself |
|
|
72
|
+
|
|
58
73
|
|
|
59
74
|
`<project>` is `--project`, or the current directory when you omit it. It must already exist. Running `init` from `~` uses your home directory as `<project>`. It does not create `~/AGENTS.md` or `~/CLAUDE.md` when those files are absent. Claude's user-level MCP server is in `~/.claude.json`; `init` does not create a project `.mcp.json`.
|
|
60
75
|
|
|
@@ -69,11 +84,13 @@ context-eng init --cursor-only --project /path/to/repo
|
|
|
69
84
|
context-eng init --claude-only --scope both --project /path/to/repo
|
|
70
85
|
```
|
|
71
86
|
|
|
72
|
-
|
|
73
|
-
|
|
|
74
|
-
|
|
|
87
|
+
|
|
88
|
+
| Command | Global file | Project file |
|
|
89
|
+
| --------------- | ---------------------------------------- | ------------------------------------------------ |
|
|
90
|
+
| `--codex-only` | `~/.codex/AGENTS.md` | none |
|
|
75
91
|
| `--cursor-only` | `~/.cursor/rules/context-eng-memory.mdc` | `<project>/.cursor/rules/context-eng-memory.mdc` |
|
|
76
|
-
| `--claude-only` | `~/.claude/CLAUDE.md`
|
|
92
|
+
| `--claude-only` | `~/.claude/CLAUDE.md` | `<project>/.claude/rules/context-eng-memory.md` |
|
|
93
|
+
|
|
77
94
|
|
|
78
95
|
`--scope` is `global`, `project`, or `both`. With no `--project`, scope defaults to `global`. With `--project` and no `--scope`, scope defaults to `project`. `project` and `both` need `--project`.
|
|
79
96
|
|
|
@@ -270,3 +287,4 @@ npm run lint
|
|
|
270
287
|
## Related docs
|
|
271
288
|
|
|
272
289
|
- [Memory tool rules](system_prompts/rules.md) — agent contract for bind, search, write, promote, and delete
|
|
290
|
+
|