A verification layer that lets AI agents safely delete code in large codebases
Project description
CodeTruth
A verification layer that lets AI agents safely delete code in large codebases.
Agents hallucinate absence of usage. CodeTruth inverts the question — instead of "is this code used?" it asks "can we prove this code is used?" — and only surfaces a symbol for deletion when it fails to find any usage path: no call, no import, no inheritance, no string reference, no reflection target, no framework registration. Detection is deterministic; the agent only reads the evidence and decides. It is a risk assessor for code deletion, not a dead code detector.
Statuses
| Status | Meaning | Recommended action |
|---|---|---|
safe_to_delete |
zero usage paths found under every analysis rule, and the name verified absent from all repo text outside its own definition | delete |
likely_dead |
no usage found, but external exposure can't be ruled out (public API, module, test-only) | review_required |
uncertain_dynamic_risk |
weak evidence exists (string refs, reflection, dynamic module) | review_required |
definitely_used |
strong reference or framework entry point proven | keep |
Install
Requires Python 3.10+. The core is lightweight (networkx + PyYAML);
the MCP server and the JS plugin are opt-in extras.
pip install codetruth # CLI + Python API (dead-code gate, CI, scripts)
pip install "codetruth[mcp]" # + the agent-facing MCP server
pip install "codetruth[javascript]" # + the JS/TS plugin (beta)
pip install "codetruth[mcp,javascript]" # everything (or: codetruth[all])
- Not using an agent? Plain
pip install codetruthis all you need — the CLI (codetruth scan), Python API (from codetruth import scan), HTML report, and--cigate work with no extra dependencies. Themcpextra pulls a web-server stack (pydantic/starlette/uvicorn) and is only for the MCP server, so the core deliberately doesn't require it. - Using it with Claude Code / an MCP agent? Install
"codetruth[mcp]", thenclaude mcp add codetruth -- codetruth mcp. - If the
codetruthcommand isn't found, your Python scripts dir isn't on PATH — usepython -m codetruth.cli(andpython -m codetruth.mcp_server).
MCP (the primary interface — for agents)
pip install "codetruth[mcp]"
claude mcp add codetruth -- codetruth mcp
Tools exposed: scan(repo_path, ...) and check_deletion_safety(repo_path, symbol).
The agent workflow: identify symbol → call check_deletion_safety → only delete
on safe_to_delete; everything else routes to human review.
CLI
codetruth scan ./repo # review queue, strongest candidates first
codetruth scan ./repo -v --json out.json # full evidence
codetruth scan ./repo --app-mode # application (not library) repos:
# public symbols may be safe_to_delete
codetruth scan ./repo --strict # flag orphaned "useless clumps"
codetruth scan ./repo --min-rank 0.5 --group # trim the tail, group by file
codetruth scan ./repo --html report.html # self-contained HTML report
codetruth scan ./repo --ci # exit 1 if dead code exists (report gate)
codetruth check ./repo pkg.module:func # one symbol's evidence record
codetruth plan ./repo pkg.module:func # advisory deletion plan (never applied)
The --ci gate is advisory like everything else: it fails the build so a
human looks at provably-dead code — it never deletes. Mark false alarms with
# codetruth: keep or a .codetruth.toml entrypoint.
What gets scanned (scope)
CodeTruth scans the directory you point it at. It never descends into
dependency, VCS, build, or environment folders — they're pruned from the walk
(so they don't slow it down or pollute results): node_modules, .git/.hg/
.svn, .venv/venv/env/virtualenv, site-packages, __pycache__,
build/dist/.eggs/wheels, the various caches, and vendored-code dirs
(vendor, third_party, _vendor, vendored). So a virtualenv or installed
package left inside your repo won't be treated as your code.
To exclude your own folders (generated code, migrations, fixtures), add a
.codetruth.toml at the repo root:
[codetruth]
ignore_paths = ["generated/", "migrations/", "**/fixtures/**"]
Ignored folders are pruned from the walk too, so excluding a large directory
also makes the scan faster. To scan just one package of a monorepo, point
codetruth scan at that package's directory.
Python API
from codetruth import scan, check_deletion_safety
result = scan("./repo")
for rec in result.candidates():
print(rec.status.value, rec.symbol, rec.evidence_against_deletion)
Cross-repo / cross-service (workspace scan)
Single-repo analysis can't see that an endpoint is called over the wire or a shared package is imported by a sibling service — the exact usage that makes distributed deletion dangerous. Scan several repos as one system:
codetruth workspace ./service-api ./service-worker ./shared-lib
from codetruth import scan_repos
ws = scan_repos(["./service-api", "./service-worker"])
for xref in ws.crossrefs:
print(xref.symbol, "<-", xref.reason)
It matches HTTP routes to client calls (a FastAPI/Flask route linked to a
requests/httpx call in another repo, path templates and params normalized)
and shared imports across repos. A symbol that looks dead in its own repo
but is reached cross-repo is raised from likely_dead/safe_to_delete to
uncertain_dynamic_risk with an explicit reason — the overlay only ever moves
a verdict toward keep. Also exposed as the scan_workspace MCP tool.
Runtime evidence (v1.5)
Static analysis can't see cross-service usage (HTTP calls, queues, cron in
other repos). @codetruth.track logs real invocations in production:
import codetruth
@codetruth.track
def maybe_dead(): ...
Or instrument a whole package with zero source edits:
import codetruth.runtime
codetruth.runtime.instrument_package("myapp") # or CODETRUTH_AUTOTRACK=myapp
Then feed the trace back: codetruth scan ./repo --runtime-log runtime.jsonl.
Observed calls promote a symbol to definitely_used; "0 calls over N days"
becomes the strongest evidence tier for deletion.
Tracing is production-safe: each process writes its own runtime-<pid>.jsonl
(merged at read — no lock contention between workers), and a daemon thread
flushes counts every $CODETRUTH_FLUSH_INTERVAL seconds (default 60), so
long-running servers land evidence without a clean exit.
Finding useless clumps (strict reachability)
codetruth scan ./repo --strict asks a harder question: is this code
reachable from any real entry point (HTTP route, CLI command, __main__,
test, declared entrypoint)? Code that is internally well-connected — functions
calling each other — but never reached from an entry point surfaces as an
orphaned clump, with every member carrying a cluster field listing its
fellow members so the whole island can be reviewed (and deleted) as a group.
Dead-cluster grouping also applies in default mode whenever unreachable
symbols reference each other.
Configuration (.codetruth.toml)
Teach the scanner about usage it can't see:
[codetruth]
app_mode = true # public symbols are internal (application)
entrypoints = [ # externally-reached symbols (cron, RPC, ...)
"jobs.nightly:run",
"services.handlers.*",
]
ignore_paths = ["migrations/", "vendor/**"]
Inline: a # codetruth: keep comment on (or above) a definition marks it as
an entry point.
Deletion plans (advisory)
codetruth plan ./repo pkg.mod:symbol (also the plan_deletion MCP tool, and
attached automatically to every safe_to_delete record) describes exactly what
a removal would involve: the decorator-to-end source span, imports that become
orphaned, and any __all__ entry. CodeTruth never applies a plan — it is
information for whoever decides.
Review-queue ranking
Every record carries a rank_score in [0, 1] — a deterministic ordering
heuristic (not a calibrated probability; see PLAN.md §4). Higher means weaker
evidence of use, so scan() and the CLI surface the strongest deletion
targets first. Within uncertain_dynamic_risk it separates a lone
string-literal reference from forty fuzzy attribute-name matches, so a big
review queue is triageable instead of flat.
Performance
Scans are cached at <repo>/.codetruth/index.json, keyed by a fingerprint of
every source and config file's (mtime, size). An unchanged repo returns the
cached result (≈15× faster on an 8k-symbol repo); any file change triggers a
full rescan. The cache never patches the graph incrementally — a stale
cross-file edge could mask a real usage path, so correctness always wins.
Bypass with --no-cache (CLI) or force_rescan (MCP). Add .codetruth/ to
.gitignore.
Architecture
Layer 1 Symbol Extraction codetruth/languages/python/extractor.py
Layer 2 Relationship Graph codetruth/languages/python/edges.py (strong/weak edges)
Layer 3 Semantic Rules codetruth/languages/python/rules.py + codetruth/rules/python/*.yaml
Layer 4 Evidence + Decision codetruth/core/evidence.py (4-way status)
The core engine is language-agnostic (codetruth/core/, LanguagePlugin
interface). Python is the full v1 plugin (FastAPI, Django, Celery, click,
pytest, SQLAlchemy, Typer rule coverage). JavaScript/TypeScript is a beta
plugin (pip install codetruth[javascript], then scan --language javascript):
tree-sitter extraction, ESM/CommonJS import resolution, tsconfig/jsconfig
paths + baseUrl aliases and monorepo workspace packages, Vue SFC
(.vue) scripts, package.json entry points (incl. scripts),
Express/Fastify/emitter callback handlers, React/JSX component and
event-handler usage, string/config wiring, eval poisoning, and external-base
cautions — with the shared evidence, ranking, cluster, backstop, and cache
layers working unchanged. Go remains a stub.
Known limitations
- Cross-service usage is invisible to static analysis alone — runtime tracing is the partial fix.
- 100% certainty is impossible;
safe_to_deletemeans "no usage path found under the defined rules," not a mathematical proof. - Framework rule coverage (Layer 3) is a maintained knowledge base, never
finished. New rules go in
codetruth/rules/python/*.yaml— no code changes.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codetruth-0.3.2.tar.gz.
File metadata
- Download URL: codetruth-0.3.2.tar.gz
- Upload date:
- Size: 84.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ac918a5db5e95f6def37f67ab08888d53406955686696a359b84ec00bf5f1de
|
|
| MD5 |
e4b96f88f23d5599102d2df7640e3941
|
|
| BLAKE2b-256 |
5b2209a3cbeeb2168bc7c24cec0dd38408ff4dd37d2b0d22920cdf263103818e
|
Provenance
The following attestation bundles were made for codetruth-0.3.2.tar.gz:
Publisher:
release.yml on AlaikAsif/CodeTruth
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
codetruth-0.3.2.tar.gz -
Subject digest:
3ac918a5db5e95f6def37f67ab08888d53406955686696a359b84ec00bf5f1de - Sigstore transparency entry: 2138373160
- Sigstore integration time:
-
Permalink:
AlaikAsif/CodeTruth@08a5663837d65c8c3f14aa6b4ee7aa620f2d516c -
Branch / Tag:
refs/tags/v0.3.2 - Owner: https://github.com/AlaikAsif
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@08a5663837d65c8c3f14aa6b4ee7aa620f2d516c -
Trigger Event:
push
-
Statement type:
File details
Details for the file codetruth-0.3.2-py3-none-any.whl.
File metadata
- Download URL: codetruth-0.3.2-py3-none-any.whl
- Upload date:
- Size: 81.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c1526d333d7448c7134f43f85c43e68e795884a642b97ba3aaec5f8b5b09826
|
|
| MD5 |
894f2f21550263134365f3b620ac6a44
|
|
| BLAKE2b-256 |
f49bdd9ac215a238cfe14fff3b448db675e99643c38afd5794bbfe367a30f0d9
|
Provenance
The following attestation bundles were made for codetruth-0.3.2-py3-none-any.whl:
Publisher:
release.yml on AlaikAsif/CodeTruth
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
codetruth-0.3.2-py3-none-any.whl -
Subject digest:
8c1526d333d7448c7134f43f85c43e68e795884a642b97ba3aaec5f8b5b09826 - Sigstore transparency entry: 2138373178
- Sigstore integration time:
-
Permalink:
AlaikAsif/CodeTruth@08a5663837d65c8c3f14aa6b4ee7aa620f2d516c -
Branch / Tag:
refs/tags/v0.3.2 - Owner: https://github.com/AlaikAsif
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@08a5663837d65c8c3f14aa6b4ee7aa620f2d516c -
Trigger Event:
push
-
Statement type: