Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions docs/CONTEXTMEMORY.md
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.

Comment on lines +3 to +4
Copy link

Copilot AI Feb 20, 2026

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 picoclaw for CLI commands/paths, and update occurrences like "picoclaw contributors" accordingly (ideally throughout this document for consistency).

Copilot uses AI. Check for mistakes.
## 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
```

Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repo’s exec tool blocks npm install -g by default (see docs/tools_configuration.md default deny patterns). It may be worth noting here that the install command should be run in a normal terminal, or that users must adjust exec deny patterns if attempting to run it via PicoClaw tooling.

Suggested change
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 uses AI. Check for mistakes.
Verify installation:

```bash
contextmemory --help
```

---

## Initialize in picoclaw Repository

From the picoclaw project root directory:
Comment thread
AkashKobal marked this conversation as resolved.

```bash
contextmemory init
```

This creates a `.contextmemory/` directory used to store development context locally.

Example structure:

```
.contextmemory/
├── context.json
├── history/
```

This directory is local to your development environment.

Comment thread
AkashKobal marked this conversation as resolved.
Comment on lines +44 to +55
Copy link

Copilot AI Feb 20, 2026

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 uses AI. Check for mistakes.
---

## Saving Development Context

To save your current picoclaw development state:

```bash
contextmemory save "Working on picoclaw feature implementation"
```

This records relevant information such as:

- Task description
- Current progress
- Development decisions
- Next steps

You can update context at any time during development.

---

## Resuming Development Context

To restore previously saved context:

```bash
contextmemory resume
```

This copies a formatted context summary to your clipboard.

You can paste it into your AI coding assistant to restore development continuity.

---

## Optional MCP Integration

If using an MCP-compatible AI tool, add the following configuration:

Comment on lines +91 to +94
Copy link

Copilot AI Feb 20, 2026

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 uses AI. Check for mistakes.
```json
{
"mcpServers": {
"contextmemory": {
"command": "npx",
"args": ["-y", "@akashkobal/contextmemory", "mcp"]
Comment on lines +99 to +100
Copy link

Copilot AI Feb 20, 2026

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.

Suggested change
"command": "npx",
"args": ["-y", "@akashkobal/contextmemory", "mcp"]
"command": "contextmemory",
"args": ["mcp"]

Copilot uses AI. Check for mistakes.
}
}
}
```

This allows compatible tools to access stored context automatically.

---

## Example Use Cases in picoclaw Development

ContextMemory may be useful for:

- Large feature development
- Multi-session contributions
- Refactoring tasks
- AI-assisted debugging
- Tracking architectural decisions

---

## Notes

- ContextMemory is optional
- It does not change picoclaw functionality
- It stores context locally in your development environment
- It can be safely ignored if not needed

---

## Related Links

- [View package on npm](https://www.npmjs.com/package/@akashkobal/contextmemory)
- [View repository on GitHub](https://github.com/AkashKobal/contextmemory)
Loading