Skip to content

docs: document cbi terminal command #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Helweg merged 1 commit into from
Aug 19, 2026
+16 −4
Merged

docs: document cbi terminal command #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@

New installs should use `open-codebase-index` and `open-codebase-index-mcp`. The legacy package `opencode-codebase-index` and `opencode-codebase-index-mcp` remain supported aliases.

For terminal use outside an MCP client, install the package globally and use the concise `cbi` command:

```bash
npm install -g open-codebase-index
cbi status --project /path/to/repo --host jcode
cbi search "retry recovery" --project /path/to/repo
```

`cbi` provides status, indexing, search, definition lookup, and direct caller or callee inspection. See [Installation and host setup](docs/installation.md#human-cli) for the full command reference.

## Highlights

- **Semantic and hybrid retrieval** for questions where you do not know the identifier.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Claude uses:

## Human CLI

The concise `cbi` command is for terminal use. It shares OCI's index and retrieval operations, while `open-codebase-index-mcp` remains the MCP-server binary.
The concise `cbi` command is for terminal use. It shares `open-codebase-index` index and retrieval operations, while `open-codebase-index-mcp` remains the MCP-server binary.

```bash
# Inspect readiness, then create or refresh the index
Expand Down
8 changes: 5 additions & 3 deletions docs/rename-to-open-codebase-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,22 +157,24 @@ No neutral storage migration is required for the public rename.

## Package and binary compatibility design

During the transition, the new `package.json` should expose both binary names to the same built CLI:
During the transition, the new `package.json` should expose both MCP binary names to the same built CLI and the concise human CLI:

```json
{
"bin": {
"open-codebase-index-mcp": "dist/cli.js",
"opencode-codebase-index-mcp": "dist/cli.js"
"opencode-codebase-index-mcp": "dist/cli.js",
"cbi": "dist/cbi.js"
}
}
```

Keep `src/cli.ts` and `dist/cli.*` as stable executable facades. The MCP implementation remains under `src/adapters/mcp/`.
Keep `src/cli.ts` and `dist/cli.*` as stable MCP executable facades. Keep `src/cbi.ts` and `dist/cbi.*` as the stable human CLI facade. The MCP implementation remains under `src/adapters/mcp/`.

Before publishing, test:

- direct npm execution of both binary names,
- direct npm execution and global installation of `cbi`,
- global and local installs,
- symlink entrypoint detection,
- ESM and CommonJS loading,
Expand Down
Loading