cbm

Unofficial community tool. cbm-tool is an independent community wrapper for codebase-memory-mcp. It is not maintained, endorsed, or supported by DeusData / the upstream codebase-memory-mcp project.

Cross-platform convenience wrapper for the codebase-memory-mcp index_repository command.

Supports Linux, macOS, and Windows (PowerShell).

What it does

cbm is an unofficial community wrapper that makes it easy to index a local git repository into the codebase-memory-mcp knowledge graph, with sensible defaults and a friendlier CLI.

It also includes a setup command that configures local AI editors (Claude Code, Cursor, Codex CLI, Cline, Windsurf) to use codebase-memory-mcp and to prefer the knowledge graph when exploring code.

Project Layout

cbm-tool/
├── bin/
│   ├── cbm              # Linux / macOS entrypoint (Bash)
│   └── cbm.ps1          # Windows entrypoint (PowerShell)
├── install/
│   ├── install.sh       # Linux / macOS installer
│   └── install.ps1      # Windows installer
├── docs/
│   ├── USAGE.md         # Command reference and examples
│   ├── USAGE.zh-CN.md   # 中文使用指南
│   ├── INSTALL.md       # Per-OS installation instructions
│   └── INSTALL.zh-CN.md # 中文安装说明
├── tests/
│   ├── test_unix.sh     # Linux / macOS tests
│   └── test_windows.ps1 # Windows tests
├── Makefile             # Linux / macOS convenience targets
├── share/
│   └── cbm/
│       └── rules/
│           └── codebase-memory.md  # Default rule template
├── README.md
└── LICENSE

Quick Start

Linux / macOS

# One-liner (recommended)
curl -fsSL https://github.com/fxjs/cbm-tool/releases/latest/download/install.sh | bash

# Or from a local clone
make install

cbm .

Windows

# One-liner (recommended)
irm https://github.com/fxjs/cbm-tool/releases/latest/download/install.ps1 | iex

# Or from a local clone
.\install\install.ps1

cbm.ps1 .

Configure your AI editors

Back up your editor configs first. cbm setup modifies editor configuration and rules files. Run cbm setup --dry-run to preview the changes, and back up the listed files before applying them.

# Auto-detect installed editors and configure them
cbm setup

# Preview changes without applying
cbm setup --dry-run

# Configure a specific editor
cbm setup --editor cursor

# Remove configuration
cbm setup --uninstall

The rule template lives at share/cbm/rules/codebase-memory.md. Pass a custom version with cbm setup --rules-file ./my-rules.md.

Update cbm or codebase-memory-mcp

# Update cbm-tool itself from the latest GitHub release (verifies SHA-256 checksum)
cbm update self

# Preview the self-update
cbm update self --dry-run

# Update codebase-memory-mcp via its own official updater
cbm update codebase-memory-mcp

cbm update self downloads the latest release asset of cbm-tool from GitHub and verifies its SHA-256 checksum before replacing the installed script. cbm update codebase-memory-mcp runs the official upstream updater.

See docs/INSTALL.md for detailed installation steps and docs/USAGE.md for the full command reference.

中文文档：README.zh-CN.md | 安装指南 | 使用指南。

Development

# Run Unix tests
make test

# Lint shell scripts (requires shellcheck)
make lint

On Windows, run the PowerShell tests with:

.\tests\test_windows.ps1

License

MIT