Documentation
Everything you need to get Memorum running for your team.
Getting Started
Install the GitHub App
Click the button below to install Memorum on your GitHub organization or repository. You can select specific repositories or grant access to all.
Install GitHub App- Read pull requests and comments
- Write comments on pull requests
- Read repository contents (for diff analysis)
We do not access secrets, deployments, or administrative settings.
Open a Pull Request
That's it. Open any PR and Memorum will automatically analyze the diff, detect architectural patterns, and insert a structured "Memorum Analysis" block into the PR body. No configuration files, no CI changes.
Search Later
When a PR is merged, the decision is captured permanently. Use the dashboard to search by file, author, category, or time.
Go to Dashboard →How It Works
1. PR Opened
When a PR is opened, Memorum receives a webhook and analyzes the diff. It identifies which layers are touched (auth, api, db, ui), classifies the change type (AUTH_FLOW_CHANGE, DATA_MODEL_CHANGE, etc.), and assesses risk level.
2. Analysis Injected
Memorum inserts a structured block into the PR body with: Why This Change (AI-generated, editable), Category, Risk Level, Layers Touched, Review Gate warnings, and Architectural Questions for reviewers to consider.
3. Human Edits Preserved
Developers can edit the "Why This Change" field and answer Architectural Questions. These edits are detected and preserved. When the PR updates, Memorum re-analyzes but keeps human context intact.
4. PR Merged = Intent Captured
When the PR is merged, the final state (with all human edits) is promoted to a permanent "Intent" record. This is now searchable by file, commit, author, or time.
Frequently Asked Questions
What data does Memorum access?
Memorum reads PR diffs, titles, descriptions, and comments. It writes only to PR bodies (to inject the analysis block). It does not access secrets, environment variables, deployments, or administrative settings.
Where is my data stored?
Intent records are stored in a secure PostgreSQL database hosted on AWS. We do not store full code diffs—only metadata like file paths, categories, and the 'Why' summary. Your code stays on GitHub.
Can I remove Memorum from a repository?
Yes. Uninstall the GitHub App at any time from your GitHub settings. Existing intent records remain in Memorum (for historical search) but no new analysis will occur.
Does it slow down my PRs?
No. Memorum processes asynchronously. The analysis block is injected within seconds of opening a PR, but it doesn't block any GitHub workflows or CI.
Can developers opt out of analysis on specific PRs?
Currently, Memorum analyzes all PRs. We're considering adding a skip flag (e.g., [skip-memorum] in PR title) for trivial changes. Contact us if this is important to your team.
How do I search for decisions about a specific file?
Use the Dashboard. Load your repository, then click 'Search by File' and enter a file path or directory prefix. Memorum will show all merged PRs that touched that path.
Is there an API?
Yes. See the API Reference section below. All intent data is accessible via REST endpoints with API key authentication.
What if I find a bug or have a feature request?
Email us at hello@memorum.dev. We respond within 24 hours.
Security & Privacy
Minimal Permissions
We request only the permissions needed: read PR content, write PR comments. No admin access, no deployment access, no secrets access.
No Code Storage
We do not store your source code. We store file paths, change categories, and summaries. Your code remains on GitHub.
Encrypted in Transit
All communication uses TLS 1.3. Webhooks from GitHub are verified using HMAC signatures.
Data Deletion
Uninstall the app to stop new analysis. Contact us to request deletion of all historical intent records.
API Reference
Base URL: https://api.memorum.dev
Authentication
All endpoints require an API key passed via the x-api-key header.
curl -H "x-api-key: YOUR_API_KEY" https://api.memorum.dev/api/intentsEndpoints
/api/healthHealth check/api/intents/by-repoGet intents by repositoryAuth/api/intents/by-fileSearch intents by file pathAuth/api/intents/by-commitGet intents by commit SHAAuth/api/intents/by-sourceGet intents by PR/MR sourceAuth/api/intentsCreate a new intentAuth/api/runs/upsertCreate/update draft runAuth/api/runs/promotePromote draft to intentAuthNeed help?
Contact us at hello@memorum.dev. We typically respond within 24 hours.