-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Add ContextMemory integration guide #551
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,134 @@ | ||||||||||
| # ContextMemory Integration Guide | ||||||||||
|
|
||||||||||
| This guide explains how picoclaw contributors can optionally use ContextMemory to persist development context across AI-assisted coding sessions. | ||||||||||
|
|
||||||||||
| ## Overview | ||||||||||
|
|
||||||||||
| ContextMemory is a CLI tool that helps developers save and restore their working context, including: | ||||||||||
|
|
||||||||||
| - Current task | ||||||||||
| - Goals and decisions | ||||||||||
| - Implementation progress | ||||||||||
| - Next planned steps | ||||||||||
|
|
||||||||||
| This can be useful when working with AI coding assistants such as ChatGPT, Claude, or Cursor, allowing contributors to resume work without manually reconstructing project context. | ||||||||||
|
|
||||||||||
| ContextMemory does not modify picoclaw source code and is entirely optional. | ||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
| ## Installation | ||||||||||
|
|
||||||||||
| Install ContextMemory globally using npm: | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm install -g @akashkobal/contextmemory | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
|
||||||||||
| Note: The picoclaw exec tool blocks `npm install -g` by default (see `docs/tools_configuration.md`). Run this install command in a normal terminal, or adjust the exec deny patterns if you need to run it via PicoClaw tooling. |
Copilot
AI
Feb 20, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider calling out that .contextmemory/ should not be committed. Adding a note here to include .contextmemory/ in .gitignore (similar to how .picoclaw/ is ignored) would help prevent accidental check-ins of local context/history.
Copilot
AI
Feb 20, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The MCP section says "add the following configuration" but doesn’t specify where (which config file / which MCP client(s), and whether this is per-user or per-repo). Please name the target config location(s) and any required restart/enable steps so contributors can apply this correctly.
Copilot
AI
Feb 20, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using npx with -y and without a version pin will execute whatever package is currently published, which is a supply-chain risk and can reduce reproducibility. Prefer pinning an explicit version (and consider avoiding -y, or at least explaining the security tradeoff) in the recommended MCP command.
| "command": "npx", | |
| "args": ["-y", "@akashkobal/contextmemory", "mcp"] | |
| "command": "contextmemory", | |
| "args": ["mcp"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use consistent project naming: in prose, other docs refer to the project as "PicoClaw" (capitalized). Reserve
picoclawfor CLI commands/paths, and update occurrences like "picoclaw contributors" accordingly (ideally throughout this document for consistency).