@tricknowtech/context 0.1.1 → 0.3.0

package/README.md

@@ -10,7 +10,31 @@ npx @tricknowtech/context init
 
 ## The problem
 
-Open the same project on a second machine and the assistant knows nothing. Your instruction files travel with the repo, but the parts that actually accumulate — the per-project memory, your custom skills, and the thread of what you were doing — live in `~/.claude` and never leave the machine that built them.
+Open the same project on a second machine and your assistant knows nothing. Instruction files travel with the repo, but the parts that actually accumulate — per-project memory, custom skills and prompts, and the thread of what you were doing — live in your home directory and never leave the machine that built them.
+
+## Works with the tool you actually use
+
+Assistants are detected automatically, from what's installed and what the repo already contains:
+
+| Tool | Project files | User-global |
+|---|---|---|
+| Claude Code | `CLAUDE.md`, `.claude/**` | memory, skills, agents, plans |
+| OpenAI Codex | `AGENTS.md`, `.codex/**` | `AGENTS.md`, `config.toml`, prompts |
+| Cursor | `.cursorrules`, `.cursor/rules/**` | global rules |
+| GitHub Copilot | `.github/copilot-instructions.md`, instructions, prompts | — |
+| Gemini CLI | `GEMINI.md`, `.gemini/**` | `GEMINI.md`, settings, commands |
+| Windsurf | `.windsurfrules`, `.windsurf/**` | — |
+| Cline | `.clinerules` | — |
+| Aider | `CONVENTIONS.md`, `.aider.conf.yml` | — |
+| Continue | `.continue/**` | — |
+
+Each tool's home-directory config is namespaced in the store (`assistants/codex/…`) and restored to the right place on the other machine — `~/.codex`, `~/.gemini`, `~/.claude` — even when that machine's home and project paths are completely different.
+
+This also works across a *team* on different tools: a Cursor user's rules sync for a Claude user, because detection keys off what's in the repo, not just what's installed locally. Pin it explicitly if you'd rather:
+
+```json
+{ "assistants": ["claude", "codex"] }
+```
 
 ## What it does
 
@@ -18,10 +42,17 @@ Open the same project on a second machine and the assistant knows nothing. Your
 
 ```bash
 ctx push      # collect context into the store
-ctx pull      # restore it on another machine
+ctx pull      # restore it, and print where you left off
 ctx status    # what changed since the last push
+ctx handoff   # show or write the session handoff
+ctx doctor    # check the setup is actually wired correctly
 ```
 
+Start with `ctx doctor` if anything seems off — it verifies the pieces that
+fail silently, including whether your store is accidentally gitignored (in
+which case it never reaches the other machine) and whether restored memory
+lands where Claude Code actually reads it.
+
 Commit `.contextsync/` and your teammates — and your other laptop — get the same context on clone.
 
 ### It skips what git already carries
@@ -46,7 +77,25 @@ Claude Code names its per-project directories after the absolute project path
 
 `/context push` asks the model to write `.contextsync/handoff.json` first — goal, decisions made, open threads, files touched, next step. Only the model has the conversation; only the CLI has the disk, so the slash command is the one place both are available.
 
-On the other machine, `/context pull` restores everything and reads the handoff back, so the new session starts oriented instead of blank.
+On the other machine, `/context pull` restores everything and reads the handoff back, so the new session starts oriented instead of blank:
+
+```
+Where you left off  (2h ago)
+
+  Goal       Build the context-sync tool and publish it
+  Next step  Start the cloud remote, leading with the token-scoping fix
+
+  Decided:
+    · Local-first: store is committed to the repo, cloud is an optional remote
+  Still open:
+    · mcp:* token abilities are granted but never checked
+```
+
+The handoff is validated on write and on read — a model-authored file that's
+malformed is reported rather than silently ignored, since a handoff that looks
+present but says nothing is worse than an obviously absent one. `ctx push`
+tells you when no handoff was written, so you never discover it only after
+arriving on the other machine.
 
 ## Safety