You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 68f81a0
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/CONFIGURATION.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
# Configuration Reference
2
2
3
-
This page documents the configuration and persisted runtime files used by `codebase-memory-cli`. Several filesystem paths retain the historical `codebase-memory-mcp` name for compatibility; those paths do not represent an MCP product interface.
3
+
This page documents the configuration and persisted runtime files used by `codebase-memory-cli`.
4
4
5
5
## At a Glance
6
6
7
7
| Purpose | Path | Format | Notes |
8
8
|---|---|---|---|
9
-
| Global custom extension mapping |`$XDG_CONFIG_HOME/codebase-memory-mcp/config.json`| JSON | Falls back to `~/.config/codebase-memory-mcp/config.json` when `XDG_CONFIG_HOME` is unset. |
9
+
| Global custom extension mapping |`$XDG_CONFIG_HOME/codebase-memory-cli/config.json`| JSON | Falls back to `~/.config/codebase-memory-cli/config.json` when `XDG_CONFIG_HOME` is unset. |
CBM resolves `CBM_CACHE_DIR` to a canonical per-account path before using any of these locations. The log directory and files are private to the account.
18
18
@@ -25,13 +25,13 @@ Two optional JSON files let you map additional file extensions to built-in langu
25
25
Default path:
26
26
27
27
```text
28
-
$XDG_CONFIG_HOME/codebase-memory-mcp/config.json
28
+
$XDG_CONFIG_HOME/codebase-memory-cli/config.json
29
29
```
30
30
31
31
Fallback when `XDG_CONFIG_HOME` is unset:
32
32
33
33
```text
34
-
~/.config/codebase-memory-mcp/config.json
34
+
~/.config/codebase-memory-cli/config.json
35
35
```
36
36
37
37
### Per-project config
@@ -67,7 +67,7 @@ Notes:
67
67
The `config` subcommand stores runtime settings in a small SQLite database:
@@ -130,7 +130,7 @@ These environment variables affect runtime behavior:
130
130
| Variable | Default | Description |
131
131
|---|---|---|
132
132
|`CBM_ALLOWED_ROOT`|*(unset)*| Confine `index_repository` to paths within this directory. When set, a `repo_path` that resolves (after symlink / `..` resolution) outside this root is refused, and the same check now applies to the graph UI's `POST /api/index` route rather than only to one request path. Unset imposes no *containment* restriction — but see the always-on limits below, which apply whether or not this is set. Useful when agentic callers operate in a repository and indexing scope must remain human-controlled. |
133
-
|`CBM_CACHE_DIR`|`~/.cache/codebase-memory-mcp`| Override the cache directory used for indexes, `_config.db`, and UI `config.json`. |
133
+
|`CBM_CACHE_DIR`|`~/.cache/codebase-memory-cli`| Override the cache directory used for indexes, `_config.db`, and UI `config.json`. |
134
134
|`CBM_DIAGNOSTICS`|`false`| Enable periodic `snapshot.json` and retained `trajectory.ndjson` below a fresh owner-private directory in the system temp directory. The daemon records the randomized paths in the `diagnostics.start` discovery record (a single JSON line) in `${CBM_CACHE_DIR}/logs/cbm-daemon.log`; that one record is emitted even when `CBM_LOG_LEVEL` suppresses ordinary logging, so the paths always remain discoverable. |
135
135
|`CBM_DOWNLOAD_URL`| GitHub releases | Override the update download URL. |
136
136
|`CBM_LOG_LEVEL`|`info`| Set the log level to `debug`, `info`, `warn`, `error`, or `none` (or `0`-`4`). One-shot CLI messages use that command's stderr; retained detached-runtime events use `${CBM_CACHE_DIR}/logs/cbm-daemon.log`. |
0 commit comments