mirror of
https://github.com/basicmachines-co/basic-memory
synced 2026-06-21 13:47:35 +00:00
phernandez
77 lines
2.9 KiB
Markdown
77 lines
2.9 KiB
Markdown
# Basic Memory Claude Code Plugin
|
|
|
|
**Claude Code-specific plugins** for [Basic Memory](https://basicmemory.com) knowledge management.
|
|
|
|
This package lives in the canonical [`basic-memory`](https://github.com/basicmachines-co/basic-memory) repository under `plugins/claude-code/`. It uses [Claude Code's plugin format](https://docs.claude.com/en/docs/claude-code/plugins) — skills and hooks bundled into an installable marketplace. It only works with Claude Code.
|
|
|
|
> **Looking for framework-agnostic skills?** See the top-level [`skills/`](../../skills) directory — `SKILL.md` files that work in Claude Code, Claude Desktop, and other MCP-compatible agents. Some functionality (commands, hooks) is unique to this Claude Code plugin and isn't available there.
|
|
|
|
## Installation
|
|
|
|
Add the marketplace and install the plugin:
|
|
|
|
```bash
|
|
claude plugin marketplace add basicmachines-co/basic-memory --sparse .claude-plugin plugins/claude-code
|
|
claude plugin install basic-memory@basicmachines-co
|
|
```
|
|
|
|
## Available Plugins
|
|
|
|
### basic-memory
|
|
|
|
Skills and hooks for [Basic Memory](https://github.com/basicmachines-co/basic-memory) MCP server integration.
|
|
|
|
**Skills:**
|
|
- `placement` - Decide which folder a new note belongs in (runs automatically before `write_note`)
|
|
- `knowledge-capture` - Capture important information from conversations
|
|
- `continue-conversation` - Continue previous conversations with context
|
|
- `knowledge-organize` - Maintain and organize the knowledge graph
|
|
- `research` - Research topics using web search and save to memory
|
|
- `edit-note` - Edit existing notes in the knowledge base
|
|
|
|
Skills auto-expose as slash commands in Claude Code (e.g., `/knowledge-organize`). The Basic Memory MCP server provides additional prompts (`continue_conversation`, `recent_activity`, `search`) that surface as their own slash commands.
|
|
|
|
**Hooks:**
|
|
- Pre-write placement (selects the right folder based on project conventions)
|
|
- Post-write confirmation
|
|
|
|
## Configuration
|
|
|
|
The plugin reads conventions from a unified config file:
|
|
|
|
- **Per-project:** a note titled `basic-memory` at the project root
|
|
- **Global:** `~/.basic-memory/basic-memory.md`
|
|
|
|
Sections (`## Projects`, `## Placements`, `## Formats`, `## Schemas`) define rules. H3 sub-sections (e.g. `### research`) provide project-specific overrides.
|
|
|
|
If no config exists, the plugin uses sensible built-in defaults. See [PLUGIN.md](./PLUGIN.md) for the full schema and a bootstrap walkthrough.
|
|
|
|
## Requirements
|
|
|
|
- [Basic Memory](https://github.com/basicmachines-co/basic-memory) MCP server must be configured
|
|
- Claude Code CLI
|
|
|
|
## Development
|
|
|
|
From the monorepo root:
|
|
|
|
```bash
|
|
just package-check-claude-code
|
|
```
|
|
|
|
From this directory:
|
|
|
|
```bash
|
|
just check
|
|
```
|
|
|
|
`just check` validates the root marketplace, plugin-local manifests, bundled skills, hooks, and `basic-memory-manager` agent, then runs `claude plugin validate . --strict`.
|
|
|
|
## Documentation
|
|
|
|
See [PLUGIN.md](./PLUGIN.md) for full documentation.
|
|
|
|
## License
|
|
|
|
MIT
|