scriptoriumadmin/ReMe
1
0
Fork 0
mirror of https://github.com/agentscope-ai/ReMe.git synced 2026-08-28 05:25:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
ReMe/plugins/claude_code
History
jinliyl ab66f2bb56
docs: refresh ReMe guides, diagrams, and Studio documentation (#447) 
* docs: update ReMe documentation URL

* docs: localize ReMe Studio social image

* docs(AGENTS): update agent guidelines and repository documentation structure

- Clarify coding agent guidance for keeping changes small and consistent
- Revise project principle descriptions for clarity and modern terminology
- Expand repository map with detailed component and folder explanations
- Add configuration and CLI usage instructions, including syntax and merging rules
- Elaborate on component, step registration, and application lifecycle processes
- Define jobs, steps, and state handling conventions for stateless design
- Specify workspace and file safety policies, including path restrictions and locking
- Update validation commands and testing environment recommendations
- Clarify coding and test conventions, including style and dependency policies
- Distinguish documentation boundaries and update website content contribution notes
- Reinforce change guardrails to avoid breaking backward compatibility and data loss
- Improve svg diagram formatting and textual details in auto dream and proactive flow image

* style(docs): fix font-family syntax in SVG style definitions

- Correct quotation marks around font-family names in memory-as-file.svg
- Standardize font-family formatting by removing unnecessary quotes in reme-blog-architecture.svg
- Ensure consistent CSS style formatting within SVG files for better rendering fidelity

* docs: add ReMe blog to news

* style(docs): inline svg styles and improve text formatting

- Convert multiline SVG style tags into single-line for compactness in multiple figures
- Remove redundant line breaks in subtitle text elements for consistency
- Shorten descriptive texts in SVG figures for clarity and conciseness
- Adjust font sizes and text for better readability in SVG elements
- Correct whitespace issues in Chinese markdown document for improved formatting
- Remove unused style blocks from framework structure SVG for cleaner code
2026-08-12 10:59:03 +08:00
..
.claude-plugin docs: add comprehensive documentation for auto-dream, auto-link, and auto-resource flows (#343) 2026-07-14 15:34:15 +08:00
reme docs: refresh ReMe guides, diagrams, and Studio documentation (#447) 2026-08-12 10:59:03 +08:00
README.md docs: expand ReMe guides and agent integrations (#445) 2026-08-11 13:31:11 +08:00

README.md

ReMe plugin for Claude Code

Connect Claude Code to ReMe — file-native long-term memory for AI agents. The plugin gives the agent recall (read long-term memory) and records every session automatically via a Stop hook. Consolidation of daily notes into long-term digest/ knowledge runs server-side in ReMe.

What you get

  • MCP tools from the reme server: search, traverse, daily_list, frontmatter_read, read, auto_memory_cc, and more.
  • Stop hook (hooks/auto_memory.py) — when a session ends it calls ReMe's server-side auto_memory_cc tool in a detached background process, passing only the session id. The server resolves that session's transcript on disk and records the durable facts into today's daily note. Recording is fully automatic and asynchronous — the agent never records by hand, and stopping is never delayed. Best-effort: if the server is down it logs and gives up silently.
  • Skill reme-memory — recall long-term memory before answering (semantic search, topological traverse, state daily_list/frontmatter_read, then read with citations), plus a server status check. Recording is handled silently by the Stop hook.

Deployment model

The plugin connects to a shared HTTP MCP server you start once — it does not spawn ReMe. One server means one set of background watchers / dream cron across all your Claude Code windows.

Prerequisites

  1. Install ReMe (Python 3.11+):

    pip install "reme-ai[core]"

  2. Configure model credentials in a .env (see example.env):

    EMBEDDING_API_KEY=sk-xxx
EMBEDDING_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1
LLM_API_KEY=sk-xxx
LLM_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1

  3. Start the ReMe MCP server (one time, leave it running):

    reme start service.backend=mcp service.transport=streamable-http

    It serves http://127.0.0.1:2333/mcp. To use a different port, start with service.port=<port> and update the url in .mcp.json to match.

Install the plugin

/plugin marketplace add ./plugins/claude_code
/plugin install reme@reme-marketplace

(Or point /plugin marketplace add at the GitHub repo + subpath once published.) Restart Claude Code, then run /mcp to confirm the reme server and its tools are connected; the reme-memory skill can then recall memory and report server health.

Notes

  • The plugin's MCP server URL lives in plugins/claude_code/reme/.mcp.json. Keep it in sync with how you start ReMe (host/port). The Stop hook reads this same file to find the server (override with REME_HOST / REME_PORT env vars).
  • The Stop hook needs python3 on PATH and resolves transcripts under ~/.claude/projects (override the base with CLAUDE_CONFIG_DIR). It logs to plugins/claude_code/reme/logs/auto_memory_hook.log.
  • The MCP tool-name prefix (mcp__reme__…) may include the server segment depending on your Claude Code version; the skill uses the mcp__reme__* wildcard so it works either way.