Skip to content

Commit 0818831

Browse files
committed
docs: make upstream fork attribution explicit
1 parent d52e525 commit 0818831

1 file changed

Lines changed: 22 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,26 @@
33
**Portfolio case study:** https://ngallodev-software.uk/projects/codebase-memory-cli
44
**Documentation:** https://ngallodev.github.io/codebase-memory-cli/
55

6-
Codebase Memory CLI builds a persistent structural knowledge graph of a source
7-
repository and exposes it through a local command-line interface for coding
8-
agents and humans.
9-
10-
This repository is a fork and C port of
11-
[Codebase Memory MCP](https://github.com/DeusData/codebase-memory-mcp). The
12-
fork keeps the code-intelligence engine, but removes the MCP server and its
13-
third-party MCP integration surface. It exists for workplace environments
14-
where policy prohibits using third-party MCP servers while still allowing a
15-
local, auditable developer tool.
6+
> **Upstream attribution:** this repository is a **modified fork** of
7+
> [DeusData/codebase-memory-mcp](https://github.com/DeusData/codebase-memory-mcp),
8+
> originally authored and maintained by **DeusData**. The upstream project
9+
> supplies the original architecture and substantial implementation, including
10+
> the code-intelligence engine, tree-sitter parsing, persistent knowledge graph,
11+
> indexing/storage pipeline, daemon/watcher foundation, language support, and
12+
> related capabilities. This fork does **not** claim original authorship of
13+
> those systems. The upstream MIT copyright is preserved in [LICENSE](LICENSE).
14+
> See [UPSTREAM_ATTRIBUTION.md](UPSTREAM_ATTRIBUTION.md) for the explicit
15+
> upstream/fork boundary.
16+
17+
Codebase Memory CLI is a CLI-first modification of that upstream project. Its
18+
purpose is narrower: remove the supported MCP server/integration surface, make
19+
the CLI the product boundary, and adapt agent-facing CLI/JSON integration,
20+
installation/security behavior, and qualification around that boundary for
21+
environments where third-party MCP servers are prohibited.
22+
23+
The underlying code-intelligence product remains substantially upstream work;
24+
this repository should be read as a modified fork, not as an independently
25+
originated implementation.
1626

1727
The product executable is `codebase-memory-cli`. Running it with no command shows CLI help; there is no supported MCP stdio server entry point.
1828

@@ -215,7 +225,7 @@ Release scanning policy: Microsoft `!ml` tolerance is the only tolerated detecti
215225

216226
## Indexing and language support
217227

218-
The existing indexing engine is intentionally unchanged by the CLI-first migration. It parses 162 languages and includes:
228+
The upstream indexing engine is intentionally preserved through the CLI-first migration. The capabilities below originate substantially in DeusData/codebase-memory-mcp; this fork exposes them through the modified CLI-first product boundary:
219229

220230
- tree-sitter-based extraction across the project’s supported grammar set;
221231
- hybrid LSP semantic enrichment for selected languages;
@@ -259,10 +269,7 @@ agent skill ─┼──> CLI / hooks ──> protocol-neutral operations ──
259269
agent hooks ─┘
260270
```
261271

262-
The CLI, hooks, daemon, supervised workers, watcher, and UI dispatch through
263-
the operation and runtime layers. Index supervision, project mutation locks,
264-
version-cohort checks, process containment, memory limits, cancellation, store
265-
recovery, and secure local coordination are part of the application itself.
272+
The CLI-first fork changes how the inherited application is exposed and integrated. The daemon, supervised workers, watcher, UI, graph/index engine, and much of the underlying runtime architecture originate upstream in DeusData/codebase-memory-mcp. Fork-specific work should be understood as modifications around the product boundary, CLI/JSON surfaces, MCP removal, integration/install behavior, security tightening, and qualification—not original authorship of the upstream architecture.
266273

267274
## Build
268275

0 commit comments

Comments
 (0)