Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
changelog:
exclude:
labels:
- ignore-for-release
authors:
- dependabot
categories:
- title: Highlights
labels:
- highlight
- title: Improvements
labels:
- enhancement
- title: Bug Fixes
labels:
- bug
- title: Other Changes
labels: []
55 changes: 55 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Release

on:
push:
tags:
- 'v*'

permissions:
contents: write

jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install shellcheck
run: sudo apt-get update && sudo apt-get install -y shellcheck

- name: Lint and test
run: make lint test

- name: Generate checksums
run: make checksums

- name: Create release
uses: softprops/action-gh-release@v2
with:
body: |
**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.

## What's in this release

- `cbm` — Linux / macOS Bash entrypoint
- `cbm.ps1` — Windows PowerShell entrypoint
- `install/install.sh` — Linux / macOS installer
- `install/install.ps1` — Windows installer
- `share/cbm/rules/codebase-memory.md` — default rule template
- `SHA256SUMS` — SHA-256 checksum manifest for all assets
- `cbm.sha256`, `cbm.ps1.sha256` — per-asset checksums

## Updater notes

- `cbm update self` downloads the latest `cbm-tool` release asset and verifies its SHA-256 checksum before replacing the installed script.
- `cbm update codebase-memory-mcp` runs the official upstream updater and is separate from cbm-tool's own update mechanism.
files: |
bin/cbm
bin/cbm.ps1
install/install.sh
install/install.ps1
share/cbm/rules/codebase-memory.md
SHA256SUMS
bin/cbm.sha256
bin/cbm.ps1.sha256
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@ desktop.ini
# Test artifacts
tests/tmp/
tests/fixtures/

# Release checksum artifacts (generated by make checksums and CI)
SHA256SUMS
*.sha256
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: install uninstall test lint
.PHONY: install uninstall test lint checksums

PREFIX ?= $(HOME)/.local
BIN_DIR = $(PREFIX)/bin
Expand All @@ -14,3 +14,8 @@ test:

lint:
shellcheck bin/cbm install/install.sh tests/test_unix.sh

checksums:
sha256sum bin/cbm bin/cbm.ps1 install/install.sh install/install.ps1 share/cbm/rules/codebase-memory.md > SHA256SUMS
sha256sum bin/cbm | awk '{print $$1}' > bin/cbm.sha256
sha256sum bin/cbm.ps1 | awk '{print $$1}' > bin/cbm.ps1.sha256
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# cbm

Cross-platform convenience wrapper for the [`codebase-memory-mcp`](https://github.com/DeusData/codebase-memory-mcp) `index_repository` command.
> **Unofficial community tool.** `cbm-tool` is an independent community wrapper for [`codebase-memory-mcp`](https://github.com/DeusData/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` makes it easy to index a local git repository into the `codebase-memory-mcp` knowledge graph, with sensible defaults and a friendlier CLI.
`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.

Expand Down Expand Up @@ -55,6 +57,8 @@ 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.

```bash
# Auto-detect installed editors and configure them
cbm setup
Expand All @@ -74,16 +78,18 @@ The rule template lives at [`share/cbm/rules/codebase-memory.md`](share/cbm/rule
### Update cbm or codebase-memory-mcp

```bash
# Update cbm itself from GitHub
# 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
# 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](docs/INSTALL.md) for detailed installation steps and [docs/USAGE.md](docs/USAGE.md) for the full command reference.

中文文档:[README.zh-CN.md](README.zh-CN.md) | [安装指南](docs/INSTALL.zh-CN.md) | [使用指南](docs/USAGE.zh-CN.md)。
Expand Down
12 changes: 9 additions & 3 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# cbm

> **非官方社区工具。** `cbm-tool` 是 [`codebase-memory-mcp`](https://github.com/DeusData/codebase-memory-mcp) 的独立社区封装工具,并非由 DeusData 或上游 `codebase-memory-mcp` 项目维护、认可或支持。

[`codebase-memory-mcp`](https://github.com/DeusData/codebase-memory-mcp) 的跨平台便捷命令行封装工具。

支持 **Linux**、**macOS** 和 **Windows**(PowerShell)。

## 功能

`cbm` 让你可以用更友好的命令行界面,把本地 Git 仓库索引到 `codebase-memory-mcp` 知识图谱中。
`cbm` 是一个非官方社区封装工具,让你可以用更友好的命令行界面,把本地 Git 仓库索引到 `codebase-memory-mcp` 知识图谱中。

它还包含一个 `setup` 命令,可以配置本地 AI 编辑器(Claude Code、Cursor、Codex CLI、Cline、Windsurf)接入 `codebase-memory-mcp`,并在探索代码时优先使用知识图谱。

Expand Down Expand Up @@ -55,6 +57,8 @@ cbm.ps1 .

### 配置你的 AI 编辑器

> **请先备份编辑器配置。**`cbm setup` 会修改编辑器配置与规则文件。运行 `cbm setup --dry-run` 预览将修改的文件,确认后再备份并应用。

```bash
# 自动检测已安装的编辑器并配置
cbm setup
Expand All @@ -74,16 +78,18 @@ cbm setup --uninstall
### 更新 cbm 或 codebase-memory-mcp

```bash
# 从 GitHub 更新 cbm 自身
# 从 cbm-tool 最新 GitHub Release 更新自身(会校验 SHA-256 校验和)
cbm update self

# 预览更新
cbm update self --dry-run

# 更新 codebase-memory-mcp
# 通过 codebase-memory-mcp 自身的官方更新器进行更新
cbm update codebase-memory-mcp
```

`cbm update self` 从 GitHub 下载 `cbm-tool` 的最新 Release 资源,并在替换本地脚本前校验其 SHA-256 校验和。`cbm update codebase-memory-mcp` 则调用上游官方更新器。

完整文档:

- [English Usage](docs/USAGE.md) / [中文使用指南](docs/USAGE.zh-CN.md)
Expand Down
Loading