Open source · contribution resources

Develop and contribute to RecallBase.

RecallBase CLI is a user-facing local product for keeping supported AI coding-agent history searchable. This page is for people who want to inspect, develop, test, package, or contribute to its open-source implementation.

Developer access is free and self-serve: install the open-source CLI or connect to the public Docs MCP without an account, API key, OAuth flow, sales contact, or cloud sandbox. RecallBase does not expose a public cloud conversation API. A separate remote sandbox is therefore not applicable: contributors run tests against repository fixtures and local SQLite data, which cannot modify RecallBase production data.

Source and contribution

Start with the public repository.

Use the repository guides as the source of truth for setup and contribution details. The website provides a stable discovery entry point without duplicating changing engineering instructions.

Contributing guide

Set up the repository, follow the contribution workflow, and run the required checks before opening a pull request.

Read CONTRIBUTING.md

Architecture notes

Review the package layout, importer contracts, local storage boundaries, and repository documentation map.

Read the architecture notes
Engineering references

Build, test, package, and report safely.

The repository documents the current contracts. Do not include conversation transcripts, local paths, tokens, cookies, or databases in issues or test reports.

CLI implementation

Understand the command surface, local archive behavior, JSON output, and the built-in local MCP server.

Review the CLI documentation

Packaging and platforms

See supported release targets and the packaging checks used for macOS, Linux, and Windows artifacts.

Review platform packaging

Security policy

Report vulnerabilities through the documented private channel instead of opening a public issue with sensitive details.

Read SECURITY.md
Official packages and interfaces

Verify the package and public contracts.

npm distributes the CLI. The local CLI MCP and the website Docs MCP are separate surfaces with different data boundaries.

SurfaceOfficial entry pointBoundary
RecallBase CLInpm package · install guideFree, self-serve local product; repository fixtures and local SQLite provide an isolated test environment without touching production data.
Local CLI MCPCLI product pageRuns on the user’s machine and accesses only the local archive the user installed.
Website Docs MCPconnection guide · server cardPublic documentation with no account, API key, or OAuth; it never exposes user conversations or account secrets.
Agent-readable guidesllms.txt · skills indexProduct documentation and privacy boundaries, not a cloud conversation API.
Product boundary

Do not build against private website APIs.

RecallBase does not publish a cloud conversation API, an OpenAPI contract for user chats, or agent authentication for raw history. Website account, billing, analytics, and extension-token routes are private product infrastructure, not supported developer integrations.