Skip to main content

Evidence-grounded repository audit CLI: deterministic scanner, MCP server, live dashboard, and a GitHub Action that posts PR diffs.

Project description

Aletheore

Aletheore Prototype

Status: Unratified prototype under VDP-0000-REQ-009 ("Prototypes and experiments MAY precede specifications, but they MUST NOT become normative without the VDP process").

This directory is deliberately out-of-band from the constitutional apparatus in ../constitution/, ../GOVERNANCE.md, ../VISION.md, and ../ROADMAP.md. It does not modify, supersede, or depend on any of that. It is not a proposal and should not be treated as one — it's just the actual, working tool.

What this is

A deterministic scanner (tree-sitter + git log, no LLM, fully unit-tested) reads a repository and writes .aletheore/evidence.json: languages, module dependency graph, modularity-based clusters, git ownership and commit cadence, secrets, dependency vulnerabilities, layer- convention violations, dependency licenses, and static API endpoint maps. Every other feature below is built on top of that same evidence and never states anything it can't cite back to a specific field in it.

Secrets, git activity, and dependency-vulnerability checks are language-agnostic. The module dependency graph (imports, clusters, layer violations) currently understands Python, JavaScript/JSX, TypeScript/TSX, Go, Rust, Java, Ruby, PHP, C, C++, and C# — other languages are still scanned for secrets/git/vulnerabilities, but get no dependency-graph or architecture analysis until a grammar is added for them.

Go resolution needs a go.mod at the repo root to know the module's own import-path prefix; without one, Go imports are left unresolved (same as any import Aletheore can't place) rather than guessed at. An import is resolved to every non-test .go file in its target directory, since Go imports whole packages, not individual files.

Rust resolution needs src/lib.rs or src/main.rs at the repo root (workspace repos with multiple crates aren't supported yet); without one, nothing resolves. It assumes directory structure mirrors the module tree (true for the vast majority of real code; #[path = "..."] escape hatches aren't supported), and handles crate::/self::/super:: paths, the implicit crate-relative form (use handlers::Handler; from the crate root), grouped ({Bar, Baz}), wildcard (::*), and aliased (as) forms.

Java resolution has no repo-root config to read at all (no go.mod/Cargo.toml equivalent) - the source root (Maven/Gradle's src/main/java, a bare src/, or the repo root itself) is inferred per-file from each file's own package declaration matching its actual directory, so it works across layouts without assuming one. Handles direct imports, wildcard imports (fanning out to every .java file in that package, same idea as Go's package-level imports), and import static (resolving to the class, not the imported member).

Ruby's require_relative always resolves relative to the current file, unambiguous. Plain require is genuinely ambiguous (the overwhelming majority are gems, external), so it only resolves against a repo-root lib/ directory - the near-universal Ruby convention for a project's own internal requires - and is left unresolved otherwise, same as an unrecognized import in any other language here.

PHP reads composer.json's autoload.psr-4 mapping (namespace prefix -> directory, longest prefix wins when more than one could match) to resolve use statements; with no composer.json, use doesn't resolve at all. require/require_once/include/include_once (including the idiomatic __DIR__ . '/../lib/util.php' form) resolve relative to the current file, the same as Ruby's require_relative.

C/C++ only resolves quoted #include "foo.h" (relative to the current file's own directory, the only part of the real preprocessor search order knowable without a build system's -I flags) - angle-bracket #include <foo.h> is always treated as external/system, never resolved, since a project using <> for its own headers via -I isn't distinguishable from a real system header without that same build info. .h is parsed with the C++ grammar (a superset that parses valid C too) since header files are ambiguously C-or-C++.

C# resolves using Namespace; at namespace granularity, not class granularity - unlike every other language here, a C# using doesn't name a specific type at all, only a namespace, so it's resolved the same way Go's package-level import already is: fan out to every .cs file in the directory that namespace corresponds to (namespace-mirrors-directory is only a convention here, not compiler-enforced, so real misses are expected for code that doesn't follow it). Also accounts for <RootNamespace> (set by every dotnet new template by default), which prepends an implicit prefix to every file's effective namespace with no corresponding directory on disk at all - verified directly against a real dotnet build/dotnet run, which is also what surfaced this: a naive "namespace must fully mirror the directory" version (correct for Java, which has no such feature) resolved nothing at all until this was accounted for.

Setup

Not yet on PyPI (the packaging and a tag-triggered publish workflow exist, but nothing has been published - see ../.github/workflows/publish-pypi.yml). Once it is:

pipx install aletheore   # or: pip install aletheore

Until then, install from source:

cd prototype
pip install -e ".[dev]"
pytest

Requires Python 3.11+.

Configuration

A scanned repo can commit a .aletheore.json at its root to extend the architecture checks — it's read as part of scan/audit, the same deterministic way requirements.txt or a policy doc already is (repo-declared conventions are themselves a fact about the repo, so this doesn't break reproducibility: same repo content in, same evidence out).

{
  "layer_markers": { "biz": 1 },
  "cluster_resolution": 1.5,
  "accepted_secrets": [
    { "path": "tests/fixtures/sample.py", "pattern": "aws_access_key_id", "match_preview": "AKIA****...MNOP" }
  ]
}
  • layer_markers — extends/overrides the built-in folder-name -> layer-rank table used by layer-violation detection (e.g. a repo using a biz/ folder that isn't one of the built-in names would otherwise never get convention_detected: true). Merges with the built-in table for non-overlapping keys; only overlapping keys get overridden.
  • cluster_resolution — passed straight into the modularity-clustering algorithm (default 1.0). Higher values favor more, smaller clusters; lower values favor fewer, larger ones.
  • accepted_secrets — a baseline of reviewed, accepted secret findings (e.g. a genuinely fake key in a test fixture that will always match a pattern). Every secrets scanner needs this: without it, --fail-on-new-secrets has no escape hatch for a known false positive - one review-and-accept, and it stops blocking CI, permanently, for that exact finding. Match on the finding's exact path, pattern, and match_preview (copy these from a scan's output or aletheore query secrets <path> - match_preview is already redacted, safe to commit). Accepted findings are not hidden - they still appear in evidence.json, aletheore query secrets, the dashboard, and the PR comment, each flagged "accepted": true/labeled "accepted (in .aletheore.json baseline)" - only the fail-gates and inline PR annotations skip them.

All three keys are optional and independently defaulted/empty if the file is missing, malformed, or only sets some of them. layer_markers/cluster_resolution (or null if there's no config file at all) are recorded verbatim in evidence.json at architecture.config_applied, so a report can cite exactly what convention was in effect for that scan.

Commands

aletheore scan [path]

Runs only the deterministic scan phase. Writes .aletheore/evidence.json and a rolling history snapshot under .aletheore/history/. No LLM call — safe to run repeatedly, in CI, or from a script.

aletheore scan .
aletheore scan . --no-check-vulnerabilities   # skip the OSV.dev dependency check
aletheore scan . --no-scan-git-history        # skip walking git history for secrets
aletheore scan . --no-check-licenses          # skip the dependency-license check
aletheore scan . --no-map-endpoints           # skip static API endpoint mapping

The license check reads each pinned PyPI/npm dependency's registry metadata (PyPI's license field falling back to its OSI classifiers; npm's license field) and categorizes it as permissive, copyleft-weak (LGPL, MPL, EPL), copyleft-strong (GPL, AGPL), or unknown — only non-permissive dependencies show up as findings, the same way OSV vulnerability checking only reports actual vulnerabilities, not every clean dependency. It also detects the repo's own declared license (pyproject.toml's license field, package.json's license field, or pattern-matching a LICENSE file's text) so a report can flag a copyleft dependency alongside what license the repo itself claims to be under - a factual categorization, not a legal compatibility verdict, which is genuinely subjective and outside what a deterministic scanner should claim.

Static API endpoint mapping records repository.api_endpoints for Flask, FastAPI-style decorators, Django urlpatterns, Express route calls, Go (net/http/gorilla/mux and Gin), Rust (Axum), Java (Spring Boot), Ruby (Rails), PHP (Laravel), and C# (both attribute-routed Controllers and Minimal API). It is intentionally source-derived: literal route declarations are recorded with method, path, framework, file, line, handler, whether the entry is an unresolved include/mount-style indirection, and an optional note for known same-file prefixes that are present but deliberately not composed into the recorded path.

scan prints its progress through each major phase as it runs — module graph build, git history, secrets, vulnerability/license checks, endpoint mapping — since some of these (the license check especially, one real network request per pinned dependency, no batching) can take a while with no other feedback otherwise. On a real terminal the license-check counter updates in place; piped to a log or CI, every dependency prints on its own line instead.

Alongside evidence.json, scan also writes .aletheore/evidence.toon — the same evidence, TOON-encoded (~30-60% fewer tokens for the same data, biggest win on the uniform arrays of same-shaped objects most of evidence.json actually is). evidence.json stays the canonical file for the dashboard and any external tooling; evidence.toon exists specifically for audit's coding-agent adapter to read instead.

Extracted module symbols include exact 1-indexed line bounds (name, start_line, end_line) for top-level functions/classes across every supported parser language. Those bounds power the semantic code index below.

aletheore index [path]

Builds a local LanceDB vector index over the repository's code chunks from an existing scan. This is explicit and never runs as a side effect of scan. Embeddings use local Ollama's OpenAI-compatible endpoint and the nomic-embed-text model.

aletheore scan .
ollama pull nomic-embed-text
aletheore index .

aletheore audit [path]

Runs a scan, then uses a selected reasoning provider to write a full grounded report to .aletheore/audit-report.md, following the per-section instructions in manual/ (repository intelligence, git intelligence, architecture, security, AI-usage detection, audience perspectives, roadmap synthesis) and citing exact evidence fields throughout.

This is a genuinely different kind of operation from everything else in this list: it spawns a full second reasoning process (up to a 10-minute timeout for CLI-backed providers) to produce prose, rather than answering a fast, deterministic query. It's meant to be run by hand, when you actually want a written document — it is not wired into CI or the MCP server, and shouldn't be: a CI gate needs to be fast and pass/fail on concrete facts, and an agent already driving an MCP session can reason over the evidence itself without spawning a nested agent process.

There are twelve distinct --agent values:

Provider family CLI adapter API/local adapter
Anthropic claude anthropic
OpenAI codex openai
Google gemini-cli gemini
Mistral mistral-vibe mistral
xAI grok-build grok
Provider-agnostic/local opencode ollama

CLI adapters require that the vendor's own CLI is installed and already authenticated. They run as local subprocesses in the repository working directory, and Aletheore does not add its own consent prompt because the vendor CLI owns its own auth, permissions, and network behavior.

API-key adapters (anthropic, openai, gemini, mistral, grok) show a fresh per-run consent prompt before the provider call. That prompt names the provider and explains that only already-computed repository evidence is sent, not raw source code. Declining exits cleanly after writing evidence. ollama is local and key-free, so it does not show that API consent prompt.

API keys are read from the provider's environment variable first (ANTHROPIC_API_KEY, OPENAI_API_KEY, MISTRAL_API_KEY, XAI_API_KEY, GEMINI_API_KEY). If no environment variable or saved key exists, Aletheore prompts for a key and asks whether to use it once or save it to ~/.config/aletheore/credentials.json with 0600 permissions. Keys are never printed or included in adapter error messages.

A note on local model reliability for ollama: treat local-model support as experimental. The default tag (llama3.1:8b) reliably fails this audit's structured, multi-round tool-calling contract — it will typically fail fast with a clear "finished without writing required section(s)" error rather than hang (Aletheore fails fast on this, it doesn't retry forever), but it will fail. This is not specific to that one model: live-tested against four local models on ordinary consumer hardware (llama3.1:8b, qwen2.5-coder:14b, deepseek-coder-v2:latest, gpt-oss:20b), all four failed this specific task — one lacked Ollama tool-calling support entirely (deepseek-coder-v2 returns does not support tools), and three produced tool calls but never reliably completed all nine sections. gpt-oss:20b initially hit the per-request timeout at the default 120s; re-tested with a 600s timeout it did not time out, but took ~10 minutes to arrive at the identical tool-calling failure the other models hit in under 3 - confirming this is a model-capability limit, not a timeout tuning problem. Raising the timeout only makes a guaranteed failure slower, so the default stays conservative. No local model has been confirmed to complete this audit successfully yet. If you get one working, especially something in the 30B+ range on capable hardware, that's genuinely useful data — there is currently no --model override flag, so trying a different tag than the built-in llama3.1:8b requires editing KNOWN_ADAPTERS in aletheore/cli.py if you're running from source. For local-model use today, the practical recommendation is: use ollama for quick/free experimentation with the understanding that it may fail, and rely on an API-key provider or a CLI-based agent (claude, codex, gemini-cli, mistral-vibe, grok-build, opencode) for a run you actually need to complete.

API/local adapters are deliberately bounded: they receive no raw repository files and no filesystem tools. They can only call read_evidence_section against .aletheore/evidence.toon, write named report sections, and finish the report.

Interactive runs always show a provider-selection menu, even if exactly one provider is available. Non-interactive runs must pass --agent NAME explicitly so automation never silently chooses a provider.

While the reasoning provider runs, an elapsed-time indicator prints so a multi-minute wait doesn't look identical to a hang (updates in place on a real terminal; prints once at the start and once at the end when piped to a log). Providers are instructed to use .aletheore/evidence.toon (see scan above) rather than the JSON copy.

aletheore audit .
aletheore audit . --agent claude
aletheore audit . --agent codex
aletheore audit . --agent openai
aletheore audit . --agent ollama

aletheore query <kind> [target]

Answers one targeted question from an existing evidence.json, without re-scanning or an LLM call.

aletheore query imports app/routes.py --path .
aletheore query imported-by app/routes.py --path .
aletheore query symbols app/routes.py --path .
aletheore query branch main --path .
aletheore query ownership --path .
aletheore query secrets app/routes.py --path .        # findings within just that file
aletheore query vulnerabilities --path .
aletheore query licenses --path .
aletheore query endpoints --path .
aletheore query cluster app/routes.py --path .
aletheore query layer-violations --path .
aletheore query changes --path .              # diff against the previous history snapshot
aletheore query search-codebase "how does auth work?" --path .
aletheore query answer "how does auth work?" --path . --agent ollama

search-codebase returns TOON-encoded semantic retrieval results from the local index. answer retrieves code chunks from that same index, gates low-confidence matches, and then uses the selected provider's simple completion path to answer with citations.

aletheore diff <old.json> <new.json>

Compares two evidence.json files directly — new/resolved secrets, API endpoints, layer violations, dependency vulnerabilities, architecture deltas. Powers the GitHub Action below.

aletheore diff old/evidence.json new/evidence.json
aletheore diff old/evidence.json new/evidence.json --fail-on-new-secrets
aletheore diff old/evidence.json new/evidence.json --fail-on-new-vulnerabilities
aletheore diff old/evidence.json new/evidence.json --fail-on-new-layer-violations

All three --fail-on-new-* flags can be combined; the command exits 1 if any of them find something new.

aletheore healthcheck [path] --base-url <url>

Runs a GET-only live check of mapped API endpoints against a running app instance. This reads repository.api_endpoints from evidence, substitutes placeholder values for path parameters such as <int:id>, {id}, and :id, skips non-GET endpoints without calling them, and writes a rotated result file under .aletheore/healthchecks/.

This command depends on live runtime state, so it is deliberately not part of deterministic scan evidence or aletheore diff.

aletheore healthcheck . --base-url http://127.0.0.1:5000

aletheore mcp [path]

Starts a stdio MCP server scoped to one repository, so a coding agent can query its structure directly instead of shelling out via Bash or re-reading files on every lookup. Every tool result is TOON-encoded rather than plain JSON — the calling agent's own token budget is what actually pays for reading these results, and evidence's shape (almost entirely uniform arrays of same-shaped objects) is exactly TOON's best case. Exposes 17 tools by default, plus one optional answer tool when started with --agent:

  • The 11 query kinds above as tools (aletheore_imports, aletheore_imported_by, aletheore_symbols, aletheore_branch, aletheore_ownership, aletheore_secrets, aletheore_vulnerabilities, aletheore_licenses, aletheore_endpoints, aletheore_cluster, aletheore_layer_violations), plus aletheore_changes.
  • aletheore_neighborhood(target) — a module's imports, dependents, and cluster in one call, instead of three round-trips.
  • aletheore_search(pattern, regex=False, path_glob=None) — literal or regex full-text search over tracked source files, capped at 200 matches.
  • aletheore_search_codebase(query, k=10) — semantic search over the local code index.
  • Optional: aletheore_answer(question, k=5) — available only when the MCP server is started with --agent, answers from the semantic index using the selected provider.
  • aletheore_scan() — triggers a fresh deterministic scan and returns a compact summary (not the full evidence dump). Does not run the agent-driven audit report — see the note under aletheore audit above for why that's a deliberate boundary, not a gap.
  • aletheore_healthcheck(base_url) — runs the same GET-only live health check as the CLI and persists the result under .aletheore/healthchecks/.
aletheore mcp .

aletheore dashboard [path]

A live local web UI (Starlette + SSE, opens in your browser): repo overview, git activity, trend charts for module/secrets/vulnerability counts across scan history, an interactive dependency graph, a separate community-aware "clusters" graph with zoom/pan, and the list of MCP tools available for the repo.

aletheore dashboard . --port 8420

GitHub Action

../action.yml ("Aletheore" on the Marketplace) is a composite Action that scans a PR's base and head refs and reports the diff three ways:

  • A PR comment — new/resolved secrets, new/resolved secrets found in git history, new/resolved dependency vulnerabilities, new/resolved layer-convention violations, and aggregate deltas (module count, dependency-graph edge count, commit count). Updates the same comment on subsequent pushes instead of spamming new ones.
  • Inline annotations on new secrets specifically — shown directly on the changed line in the PR's "Files changed" tab. Scoped to current-tree secrets only, since that's the only finding type with both a real file path and a real line number: history-secret findings point at an old commit with no line in the current tree, vulnerabilities are package-level, and layer violations are file-level (a "from" file imports a "to" file) — none of those have a specific line to honestly point at, so they stay in the PR comment rather than getting a fabricated line number.
  • The run's Step Summary — the same content as the PR comment, written on every run regardless of event type, so a plain push (no PR to comment on) still shows something.

A secret accepted via .aletheore.json's accepted_secrets (see Configuration above) is labeled, not omitted, in the comment and Step Summary, and is excluded from inline annotations and every --fail-on-new-* gate.

It only ever calls aletheore scan and aletheore diff, matching the reasoning above: CI needs something fast and deterministic, not a full agent-driven audit.

- uses: Aletheore/Aletheore@master    # pin to a tagged release once one exists past 0.1.0
  with:
    fail-on-new-secrets: true              # exit 1 if a new real (non-placeholder) secret appears
    fail-on-new-vulnerabilities: true      # exit 1 if a new dependency vulnerability appears
    fail-on-new-layer-violations: true     # exit 1 if a new layer-convention violation appears

Posting the PR comment needs permissions: pull-requests: write (and issues: write, since PR comments use the Issues API) on the calling workflow's job — set post-pr-comment: false to skip just that part and still get annotations, the step summary, and the diff-json output.

Continuity

Every scan (and audit, which scans first) saves a timestamped snapshot to .aletheore/history/ (last 20 kept). aletheore query changes / aletheore_changes diff the two most recent snapshots, and the dashboard's trend charts read the full history.

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

aletheore-0.4.0.tar.gz (230.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aletheore-0.4.0-py3-none-any.whl (181.7 kB view details)

Uploaded Python 3

File details

Details for the file aletheore-0.4.0.tar.gz.

File metadata

  • Download URL: aletheore-0.4.0.tar.gz
  • Upload date:
  • Size: 230.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aletheore-0.4.0.tar.gz
Algorithm Hash digest
SHA256 34cd485f5660f9f722d1b4863410d5a01e0a095504b2d1c56d278f05c2b6949e
MD5 605951e21c6d4ff67dfee7d73d47ae7d
BLAKE2b-256 7168b932505b772038a98d77340518076e514a06f694114cb5c7d64619e506b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for aletheore-0.4.0.tar.gz:

Publisher: publish-pypi.yml on Aletheore/Aletheore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aletheore-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: aletheore-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 181.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aletheore-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 836b9558d0a37bdf74912f7df7e7f2deefec92c7120dfd467d6a549473ffe222
MD5 0ceb5b13b364901531ee2a297ff7b8e3
BLAKE2b-256 39c53e906db8d3dfc67871486faf46218af0e556e8729d6eab30df90737a05ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for aletheore-0.4.0-py3-none-any.whl:

Publisher: publish-pypi.yml on Aletheore/Aletheore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page