English Français العربية

Perenna

السجل الرسمي أدوات المطورين

A lightweight, Git-backed permanent memory for AI agents.

الشيفرة المصدرية التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

PYPI package perenna
Claude Code 
claude mcp add perenna -e 'PERENNA_GIT_REMOTE=<PERENNA_GIT_REMOTE>' -e 'VEXOR_API_KEY=<your vexor_api_key>' -e 'VEXOR_REMOTE_RERANK_API_KEY=<your vexor_remote_rerank_api_key>' -e 'VEXOR_CONFIG_JSON=<VEXOR_CONFIG_JSON>' -- uvx perenna==0.4.1 mcp --home
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "perenna": {
            "command": "uvx",
            "args": [
                "perenna==0.4.1",
                "mcp",
                "--home"
            ],
            "env": {
                "PERENNA_GIT_REMOTE": "<PERENNA_GIT_REMOTE>",
                "VEXOR_API_KEY": "<your vexor_api_key>",
                "VEXOR_REMOTE_RERANK_API_KEY": "<your vexor_remote_rerank_api_key>",
                "VEXOR_CONFIG_JSON": "<VEXOR_CONFIG_JSON>"
            }
        }
    }
}

متغيرات البيئة

  • PERENNA_GIT_REMOTE Git remote name used for optional synchronization (for example, origin); leave unset for local-only operation
  • VEXOR_API_KEY سري Embedding provider API key (optional; overrides a stored key; providers can also be configured via `vexor init`)
  • VEXOR_REMOTE_RERANK_API_KEY سري Remote reranker API key (optional; overrides a stored key; only needed when rerank is set to remote)
  • VEXOR_CONFIG_JSON Non-secret Vexor config as a JSON object, e.g. {"provider": "gemini", "rerank": "bm25"} (optional; merged over ~/.vexor/config.json; credential fields are rejected, use the dedicated variables)

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. Perenna
  2. Why Perenna?
  3. Quickstart
  4. Documentation
  5. License

Perenna

A lightweight, Git-backed permanent memory for AI agents. Claude Code, Codex, ChatGPT, Cursor, and other MCP clients can share durable memories without sharing a vendor account or conversation history.

  • Separate MCP tools for reading, writing, and deleting memories
  • Local stdio, loopback-only Streamable HTTP, and OAuth-protected remote HTTP
  • Human-readable Markdown stored in an independent Git repository
  • Local Vexor retrieval index that can always be rebuilt from Git
  • Cross-process locking for multiple local agent processes

Why Perenna?

Your memory should follow you, not the agent you happen to be using.

Claude Code, Codex, Cursor, and ChatGPT keep memory in separate silos. Switch agents and your memory disappears. Switch machines and local memory stays behind.

Perenna gives them one shared, Git-backed memory. Local agents and ChatGPT can connect to the same self-hosted Perenna service, while every durable memory stays ordinary Markdown you can inspect, edit, version, and back up yourself.

Perenna stays focused on permanent memory: no required account, proprietary memory cloud, or automatic conversation extraction.

Quickstart

Install with your AI agent

Paste this into Claude Code, Codex, ChatGPT Desktop, Cursor, or another coding agent with terminal and local MCP configuration access:

Open the following URL, read the complete instructions, and follow them to
install and connect Perenna:
https://raw.githubusercontent.com/scarletkc/Perenna/main/docs/guides/agent-installation.md
Install a published release

Perenna requires Python 3.12+, Git, and uv.

Install Perenna
uv tool install perenna
Configure retrieval

Perenna needs a working Vexor embedding provider. For interactive provider selection and configuration, run:

uvx vexor init

Perenna automatically reuses ~/.vexor/config.json. When using process-level configuration, make sure the MCP server receives VEXOR_CONFIG_JSON plus VEXOR_API_KEY or the selected provider's key from its host environment. Remote providers receive memory text and search queries.

If you choose local embeddings, also install Perenna's local extra:

uv tool install "perenna[local]"

Vexor provider configuration covers remote and local setup. From the environment that starts the MCP client, verify the selected provider with:

uvx vexor doctor
Connect a client

For the standalone setup, configure the MCP client to start:

perenna mcp

Follow the Client setup guide for the exact client command or configuration file.

Codex and Claude Code can also install the optional memory behavior Skill:

perenna skill install --agent codex
# or
perenna skill install --agent claude-code

Repeat --agent in one command when both clients should receive the skill. The configuration reference documents user and project scope, destinations, and replacement safeguards.

Codex and Claude Code can instead install the combined Skill and MCP connection from Perenna's repository Marketplace. Follow the Plugin setup guide and choose one setup path per client.

Perenna creates its local data under ~/.perenna/ unless another home is configured.

Add optional Git synchronization

To import, publish, or fast-forward compatible history through a private Git repository, run:

perenna sync setup <repository-url>

Successful setup saves the selected remote in the Perenna home. Use perenna sync disable to return to saved local-only mode without removing the Git remote.

The configuration reference owns remote selection, credentials, conflict handling, and recovery details.

Install from source
git clone https://github.com/scarletkc/Perenna.git
cd Perenna
uv tool install .

Source contributors should use the locked environment in the development guide.

Documentation

Start with the documentation index, then follow the path for your task:

License

MIT

الأسئلة الشائعة

ما هو Perenna؟

A lightweight, Git-backed permanent memory for AI agents.

كيف أثبّت Perenna؟

يعمل على جهازك. في Claude Code: claude mcp add perenna -e 'PERENNA_GIT_REMOTE=<PERENNA_GIT_REMOTE>' -e 'VEXOR_API_KEY=<your vexor_api_key>' -e 'VEXOR_REMOTE_RERANK_API_KEY=<your vexor_remote_rerank_api_key>' -e 'VEXOR_CONFIG_JSON=<VEXOR_CONFIG_JSON>' -- uvx perenna==0.4.1 mcp --home. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج Perenna إلى مفتاح API؟

نعم. يتطلب VEXOR_API_KEY, VEXOR_REMOTE_RERANK_API_KEY، وتضبطها في إعداداته.

هل Perenna مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون Perenna؟

ينشره scarletkc. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.