Aletheore
Evidence-grounded repository audit CLI - deterministic scanner, MCP server, live dashboard, and a GitHub Action that posts PR diffs.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/Aletheore/Aletheore with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/Aletheore/Aletheore'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/aletheore--aletheore)HTML
<a href="/listings/aletheore--aletheore"><img src="/api/listings/aletheore--aletheore/badge.svg" alt="findsafeskills safety rating" /></a>Install
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 430 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <p align="center">
- <img src="assets/logo.png" alt="Aletheore" width="320">
- </p>
- <h3 align="center">Understand your code. Trace the impact of a change.</h3>
- <p align="center">
- Scan a repository into structured evidence, inspect its dependencies and ownership,
- and give coding agents and PR reviews concrete source context.
- </p>
- <p align="center">
- <a href="https://github.com/Aletheore/Aletheore/releases/latest"><img src="https://img.shields.io/github/v/release/Aletheore/Aletheore?label=release&color=dd8034" alt="Latest GitHub release"></a>
- <a href="https://pypi.org/project/aletheore/"><img src="https://img.shields.io/pypi/v/aletheore?color=blue" alt="PyPI version"></a>
- <a href="https://pypi.org/project/aletheore/"><img src="https://img.shields.io/pypi/pyversions/aletheore" alt="Supported Python versions"></a>
- <a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0-blue" alt="AGPL-3.0 license"></a>
- <a href="https://github.com/Aletheore/Aletheore/actions/workflows/tests.yml"><img src="https://github.com/Aletheore/Aletheore/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
- <a href="https://codecov.io/gh/Aletheore/Aletheore"><img src="https://codecov.io/gh/Aletheore/Aletheore/graph/badge.svg" alt="Coverage"></a>
- <a href="https://securityscorecards.dev/viewer/?uri=github.com/Aletheore/Aletheore"><img src="https://api.securityscorecards.dev/projects/github.com/Aletheore/Aletheore/badge" alt="OpenSSF Scorecard"></a>
- <a href="https://pepy.tech/projects/aletheore"><img src="https://static.pepy.tech/personalized-badge/aletheore?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads" alt="PyPI downloads"></a>
- <a href="https://mcpvault.io/servers/aletheore/health?utm_source=external_badge&utm_medium=referral&utm_campaign=mcp_health_report"><img src="https://mcpvault.io/badge/aletheore.svg" alt="MCPVault status"></a>
- <a href="https://deepwiki.com/Aletheore/Aletheore"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
- </p>
- <p align="center">
- <a href="https://trendshift.io/repositories/221622?utm_source=trendshift-badge&utm_medium=badge&utm_campaign=badge-trendshift-221622" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/221622/daily?language=Python" alt="Aletheore/Aletheore | Trendshift" width="250" height="55"></a>
- </p>
- <p align="center">
- <a href="src/README.md"><img src="https://img.shields.io/badge/Docs-CLI_reference-3276b8?style=flat-square&logo=readthedocs&logoColor=white" alt="CLI documentation"></a>
- <a href="https://github.com/apps/aletheore/installations/new"><img src="https://img.shields.io/badge/GitHub_App-Install-dd8034?style=flat-square&logo=github&logoColor=white" alt="Install the GitHub App"></a>
- <a href="https://github.com/marketplace/actions/aletheore"><img src="https://img.shields.io/badge/Marketplace-Action-2088ff?style=flat-square&logo=githubactions&logoColor=white" alt="GitHub Marketplace Action"></a>
- <a href="https://github.com/sponsors/ArihantK15"><img src="https://img.shields.io/badge/Sponsor-Support-ea4aaa?style=flat-square&logo=githubsponsors&logoColor=white" alt="Sponsor development"></a>
- <a href="https://github.com/Aletheore/Aletheore"><img src="https://img.shields.io/github/stars/Aletheore/Aletheore?style=flat-square&label=Star&color=e3b341" alt="GitHub stars"></a>
- </p>
- <p align="center">
- <a href="#quickstart">Run locally</a> ·
- <a href="https://www.aletheore.com/#walkthrough">Watch the walkthrough</a> ·
- <a href="#see-the-evidence">Explore the evidence</a>
- </p>
- ## See the workflow
- 
- [Watch the 95-second developer walkthrough →](https://www.aletheore.com/#walkthrough)
- <!-- GitHub requires a standalone attachment URL to render the video player. -->
- <!-- markdownlint-disable-next-line MD034 -->
- https://github.com/user-attachments/assets/91b58344-d5b7-4be5-b71f-32f1da8499ed
- With background music and on-screen explanations. Follow a scan of Aletheore's own CLI source, inspect dependencies and related tests,
- then see how the evidence connects to MCP and PR review. The walkthrough separates
- captured local output from explanations of hosted features.
- ## Quickstart
- Requires **Python 3.11–3.14** and [pipx](https://pipx.pypa.io/latest/how-to/install-pipx.html).
- Run these commands from a repository you want to inspect:
- ```bash
- pipx install aletheore
- aletheore scan .
- aletheore query hotspots
- aletheore dashboard .
- ```
- Open the dashboard at the local URL printed in your terminal. The scan writes
- `.aletheore/air.json`, a compact `.aletheore/air.toon`, and history snapshots.
- The deterministic scanner does not call an LLM. Local scanning and structural queries
- need no Aletheore account or model API key. Registry lookups and optional scanner integrations
- can use the network; see [Data and network behavior](#data-and-network-behavior).
- Already installed? Update with `pipx upgrade aletheore`.
- For a virtual environment or source installation, see the [setup guide](src/README.md#setup).
- ### Try the built-in demo
- ```bash
- aletheore demo
- ```
- The demo creates a small synthetic Python repository with local Git history and runs
- the real scanner to build reusable evidence, retrieve source, trace imports, and execute
- a local MCP tool call. In a terminal, arrow-key menus guide one screen at a time,
- with actions to open the sample dashboard or try your own repository. Use `aletheore demo --plain`
- for a printable report; piped output also runs without prompts.
- You can also select **Take the guided demo** from the `aletheore` home menu.
- Tests are suggested, not executed. Git must be installed; no account,
- model, or repository clone is needed. The sample and evidence remain in a temporary
- directory for follow-up queries and the dashboard. Delete that directory when finished.
- ## See the evidence
- ### Explore a repository's dependencies
- [](assets/readme-dependencies.png)
- A real local scan of Aletheore's CLI source. Hover modules in the dashboard to explore
- resolved imports. Security checks were disabled for this capture; graph nodes do not
- represent a clean security verdict.
- ### Read a finding where you review code
- [](https://github.com/Aletheore/Aletheore/pull/1128)
- An actual bot comment on [PR #1128](https://github.com/Aletheore/Aletheore/pull/1128).
- The screenshot shows the review surface; a finding remains something to investigate.
- ### Explore AIRview
- [](https://www.aletheore.com/#live-title)
- The public AIRview demo, captured from the website using Aletheore's own module graph.
- [Try the interactive version](https://www.aletheore.com/#live-title) to drag modules and
- trace imports. This is the public demo rather than an authenticated hosted workspace.
- ## Start with a question
- Run a scan first. Replace the example paths and symbol with names from your repository.
- | What you need to know | Command |
- | --- | --- |
- | Where is a function defined? | `aletheore locate find_ownership` |
- | Who imports this file, directly or indirectly? | `aletheore dependents src/example.py` |
- | Where is this symbol referenced? | `aletheore usages parse_config` |
- | Which tests are related to this file? | `aletheore tests-for src/example.py` |
- | Which files change frequently? | `aletheore query hotspots` |
- | Who has contributed to a file? | `aletheore query ownership src/example.py` |
- | Which endpoints are mapped? | `aletheore query endpoints` |
- | Which secret findings need review? | `aletheore query secrets` |
- | Are there circular imports? | `aletheore cycles` |
- `dependents` follows resolved import edges. `tests-for` identifies candidates from import
- relationships and naming conventions; it does not execute tests or establish coverage.
- Ownership reflects Git history, rather than an assignment of responsibility.
- Use `aletheore query` to list available query kinds and `aletheore COMMAND --help` for options.
- ## Give your coding agent repository evidence
- ```bash
- aletheore mcp-install . --target cursor
- ```
- This writes client configuration so Cursor can launch the repository's MCP server.
- Restart or reload the client as needed. Other supported targets include Claude Code,
- VS Code, Kiro, Opencode, Antigravity, Codex CLI, and Claude Desktop; list the current
- options with `aletheore mcp-install --help`.
- An agent can inspect symbols, imports, dependents, owners, endpoints, and related evidence
- without starting each investigation from an unstructured repository dump.
- For example, ask your agent:
- > Before changing this function, use Aletheore to locate its definition, inspect its
- > references and import dependents, and identify candidate tests. Cite the evidence and
- > distinguish resolved relationships from uncertainty.
- For clients you configure manually, the server command is `aletheore mcp .`.
- Optional AI answering, semantic indexing, and external tools have their own setup and
- network requirements. See the [MCP guide](src/README.md#aletheore-mcp-path).
- ## Check and undo what an agent changes
- Shield is a local safety net for AI-written changes in a Git repository. It makes no
- model call.
- ```bash
- pipx install aletheore # or: pip install aletheore
- aletheore shield
- ```
- `aletheore shield` shows every change it plans, with a diff for each file, then waits.
- Type `yes` to set it up. Nothing is written before that. Once Shield is on, the same command shows
- its status. The explicit forms are `aletheore shield setup` and `aletheore shield status`; setup
- run again shows only what needs updating. Setup changes:
- - `.claude/settings.local.json`: Claude Code hooks for four events (before an edit, after an
- edit, end of turn, end of session), each the Python interpreter plus arguments, so no shell
- quoting is involved. This file is personal and is not committed. Entries an earlier Shield
- wrote as one shell-command string are noted by `aletheore shield status`; `aletheore shield setup`
- updates them in place.
- - The Git `pre-commit` hook: a marked block that prints Shield's report and never fails the commit.
- Tools that generate Git hooks (pre-commit, lefthook, husky) can overwrite that block;
- `aletheore shield status` then notes that the Git hook is missing, and `aletheore shield setup`
- puts it back.
- - `.git/info/exclude`: a marked block that keeps Shield's files out of `git status`.
- `.gitignore` is not touched.
- - `.aletheore/shield/config.json`, and private records under the Git directory.
- - A first local scan into `.aletheore/`, if the repository has no evidence yet.
- What it does:
- - **Guard.** After edits, at the end of a turn and at commit, it reports new or suspicious
- dependencies (checked against PyPI and npm), files the change reaches and candidate tests,
- signature changes (stated per file that imports the module, not per call site), and new secrets
- and import cycles. Vulnerability and layer-convention findings appear only when the evidence came
- from a full `aletheore scan`.
- - **Checkpoints.** Before an agent edits, Shield saves the working tree as a Git commit under
- `refs/aletheore/checkpoints/`. Your branches, index and stash are not touched. Put files back
- with `aletheore shield undo`; it saves a safety checkpoint first and never deletes a file.
- - **Receipts.** At the end of a session, `.aletheore/shield/receipts/` gets a file listing
- what changed and what the guard found.
- What it does not do:
- - It never blocks a commit or an agent turn.
- - It does not run the candidate tests. Dependency and signature checks work at the import
- level, not the call level.
- - Only PyPI and npm are checked. Any other dependency is reported as "not checked".
- - It does not refresh stale scan evidence inline; checks that need fresh evidence say they were
- skipped.
- - Each hook has a time limit. Anything the guard could not finish in time is listed as not checked,
- never reported as a finding. Measured on two 9,400-file repositories: about 0.6 s per hook on a
- copy of this repository and 0.45-0.8 s on a generated one (1.2-1.3 s at session end on both).
- Registry lookups send only the package name to `pypi.org` or `registry.npmjs.org`, never versions,
- paths or source. They run only at turn end, at commit and in `aletheore shield check`. Turn them off
- with `ALETHEORE_SHIELD_OFFLINE=1` or `"registry_lookups": false` in
- `.aletheore/shield/config.json`. With lookups on, the answers are cached in
- `~/.cache/aletheore/shield-registry-cache.json` (under your user profile on Windows), outside the
- repository; `off --purge` leaves that file. Checkpoint refs are local; `git push --mirror` pushes every ref
- including them, so avoid it or delete the refs first. Undo writes files the way `git checkout`
- would, following your line-ending and filter settings.
- `aletheore shield off` removes the hooks, config and marked blocks and keeps checkpoints and
- receipts; `--purge` deletes those too. Scan evidence in `.aletheore/` stays, and so does a
- one-line git exclude for it until you delete `.aletheore/` and run `off` again.
- Shield targets macOS, Linux and Windows; CI runs the unit tests and a CLI smoke test of setup, the
- four hooks and `off` on all three. It has not been run against a real Claude Code session on Windows. See the
- [command reference](src/README.md#aletheore-shield) for options, limits and exit codes.
- ## What you can use
- | Surface | Purpose | Start here |
- | --- | --- | --- |
- | Local CLI | Scan, locate code, inspect risks, and compare evidence | `aletheore scan .` |
- | Local dashboard | Explore dependency and cluster graphs and scan history | `aletheore dashboard .` |
- | MCP server | Let a coding agent query repository evidence | `aletheore mcp-install --help` |
- | AI audit | Generate a report using a configured coding-agent CLI or API provider | `aletheore audit --help` |
- | Hallbook | Search the bundled coding-agent skill catalog | `aletheore hallbook search "code review"` |
- | Shield | Check and undo what a coding agent changes in a Git repository | `aletheore shield` |
- | Agent context tools | Inspect tool overhead and local context savings | `aletheore tokens meter` |
- | GitHub Action | Report new and resolved findings between a PR's base and head | [Action setup](#run-in-github-actions) |
- | Hosted GitHub App | Run PR reviews and use managed repository features | [Install the app](https://github.com/apps/aletheore/installations/new) |
- Hallbook skills have individual instructions, dependencies, and licenses; review a skill
- before installing or executing it. Token auditing can invoke your configured agent;
- context profiles are optional and change which tools that agent can access.
- ## Review changes in GitHub
- The hosted GitHub App adds PR reviews, managed audits, AIRview architecture pages,
- AI-marked symbol documentation, and endpoint monitoring with source context.
- Availability depends on the selected plan. Free AI reviews are globally rate-limited and
- subject to availability. See [current plans and limits](https://www.aletheore.com/pricing)
- rather than relying on a price copied into this README.
- [Install the Aletheore GitHub App](https://github.com/apps/aletheore/installations/new)
- and choose the repositories to connect.
- ### Run in GitHub Actions
- <details>
- <summary><strong>GitHub Actions workflow and execution notes</strong></summary>
- For a deterministic PR diff in your own workflow:
- ```yaml
- name: Aletheore
- on: [pull_request]
- permissions:
- contents: read
- pull-requests: write
- jobs:
- evidence:
- runs-on: ubuntu-latest
- steps:
- - uses: Aletheore/Aletheore@v0.13.0
- with:
- fail-on-new-secrets: true
- ```
- The Action scans both refs and reports new/resolved secrets, dependency vulnerabilities,
- and layer-convention violations. It runs `scan` and `diff`, rather than an AI audit.
- The example pins an existing release; review and pin a commit SHA for your own deployment
- policy. Fork PRs can have read-only tokens: comment posting may be unavailable even when
- analysis succeeds. See [Action inputs](action.yml) and the [CLI reference](src/README.md).
- </details>
- ## What the scanner understands
- <p>Dependency graph support, with language-specific resolution limits:</p>
- <p>
- <a href="src/README.md"><img src="https://img.shields.io/badge/Python-3776AB?style=flat-square&logo=python&logoColor=white" alt="Python dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/JavaScript-c4a800?style=flat-square&logo=javascript&logoColor=white" alt="JavaScript dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/Go-007D9C?style=flat-square&logo=go&logoColor=white" alt="Go dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/Rust-9b4f23?style=flat-square&logo=rust&logoColor=white" alt="Rust dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/Java-b85e00?style=flat-square&logo=openjdk&logoColor=white" alt="Java dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/Kotlin-7F52FF?style=flat-square&logo=kotlin&logoColor=white" alt="Kotlin dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/Ruby-CC342D?style=flat-square&logo=ruby&logoColor=white" alt="Ruby dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/PHP-777BB4?style=flat-square&logo=php&logoColor=white" alt="PHP dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/C-5969ab?style=flat-square&logo=c&logoColor=white" alt="C dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/C%2B%2B-00599C?style=flat-square&logo=cplusplus&logoColor=white" alt="C++ dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/C%23-512BD4?style=flat-square&logo=dotnet&logoColor=white" alt="C# dependency graph support"></a>
- <a href="src/README.md"><img src="https://img.shields.io/badge/Swift-c74b27?style=flat-square&logo=swift&logoColor=white" alt="Swift dependency graph support"></a>
- </p>
- <details>
- <summary><strong>Language support, available evidence, and analysis limits</strong></summary>
- Dependency graphs support **Python, JavaScript/JSX, TypeScript/TSX, Go, Rust, Java, Kotlin,
- Ruby, PHP, C, C++, C#, and Swift**, with language-specific resolution limits.
- Secrets and Git analysis can still apply to other source files.
- Dependency checks depend on supported manifests, resolved versions, and registry coverage.
- The evidence can include imports, symbols, clusters, Git ownership and activity,
- secret findings, dependency vulnerabilities and licenses, static analysis, endpoints,
- database schema, infrastructure, and error handling. Some checks depend on installed
- external scanners or explicit configuration. Missing tools and unsupported analysis
- must be distinguished from a clean result.
- Static evidence is a starting point for investigation. Dynamic dispatch, runtime configuration,
- external services, and unresolved imports can leave gaps. A source citation makes a claim
- inspectable; it does not by itself prove that a bug exists or that a change is safe.
- Read [resolution details and configuration](src/README.md) for the limits that apply to your language.
- </details>
- ## Data and network behavior
- Local scans build evidence on your machine. Enabled registry checks, optional integrations,
- crash reporting, and AI features have their own network behavior.
- <details>
- <summary><strong>Network requests, crash reporting, and offline scan flags</strong></summary>
- The local deterministic scan builds evidence on your machine. Its network behavior depends
- on enabled checks and integrations:
- - Dependency vulnerability and license checks contact OSV and package registries.
- - Semgrep can fetch rules and send its own metrics; optional integrations such as SonarQube
- have separate submission behavior.
- - CLI startup can check PyPI for updates. Set `ALETHEORE_NO_UPDATE_CHECK=1` to disable that check.
- - Crash reporting is enabled by default and can be disabled with
- `aletheore config crash-reporting off` or `ALETHEORE_CRASH_REPORTING=0`.
- - AI audits, hosted features, and configured semantic services send the context required
- by the selected workflow to their configured services. Local evidence can contain
- sensitive metadata or source excerpts; review it before sharing.
- Before scanning, inspect potential traffic for the resolved configuration:
- ```bash
- aletheore scan . --explain-network
- ```
- This prints the conditional network paths and exits without scanning. It is an
- explanation of configured behavior, rather than a firewall or packet trace.
- To skip registry and static-scanner checks for a local scan:
- ```bash
- aletheore scan . --no-check-vulnerabilities --no-check-licenses --no-check-static-analysis
- ```
- These scan flags do not configure every other command or service. Review
- [CLI configuration and crash reporting](src/README.md#crash-reporting),
- [security information](SECURITY.md), and the hosted [privacy policy](https://www.aletheore.com/privacy)
- for the workflow you choose.
- </details>
- ## Evidence and benchmarks
- Explore [published scan examples](https://www.aletheore.com/dogfooding) and
- [benchmarks with methodology and limits](https://www.aletheore.com/benchmarks).
- The separate [benchmark repository](https://github.com/Aletheore/aletheore-benchmarks)
- contains the PR-review evaluation harness. Results depend on repository, task, model,
- and sample; they do not guarantee the same result on your code.
- ## Contribute or get help
- - [Report a bug or request a feature](https://github.com/Aletheore/Aletheore/issues).
- - Read [CONTRIBUTING.md](CONTRIBUTING.md) to work on the project.
- - Use [SECURITY.md](SECURITY.md) for vulnerability reports.
- - [Sponsor development](https://github.com/sponsors/ArihantK15).
- <details>
- <summary><strong>Repository map</strong></summary>
- | Directory | Contents |
- | --- | --- |
- | [`src/`](src/) | CLI implementation and command reference |
- | [`site/`](site/) | Next.js marketing site |
- | [`docs/operations/`](docs/operations/) | Operational baselines and runbooks |
- | [`benchmarks/`](benchmarks/) | Repository benchmark material |
- The hosted application is maintained separately from this public repository.
- </details>
- ## Licensing
- The CLI and other code in this repository are open source under the [GNU Affero General Public License v3.0](LICENSE)
- (AGPL-3.0). You can use, study, modify, and redistribute it, including at a company and
- for internal tooling, as long as you follow the AGPL. The part that matters most:
- - If you modify Aletheore and convey that covered work, or provide it for network interaction in
- circumstances covered by AGPL section 13, follow the AGPL's corresponding-source and notice
- requirements for the covered work.
- - Independent code and separate components may remain under their own licenses; whether a
- combination is a covered work depends on the AGPL and the facts of the distribution.
- - Running the unmodified CLI or Action on your own code does not put your code under the AGPL.
- If those terms don't fit, for example you want to embed Aletheore in a closed-source product
- or run a modified version as a service without publishing it, a commercial license is
- available. See [COMMERCIAL-LICENSE.md](COMMERCIAL-LICENSE.md), or email
- [arihantkaul@outlook.com](mailto:arihantkaul@outlook.com). The hosted, paid tier is
- [Aletheore AIR](https://aletheore.com).
- Copyright (C) 2026 Arihant Kaul. See [NOTICE](NOTICE).
- Releases through 0.8.12 were Apache 2.0, and 0.8.13 through the version before this change were PolyForm
- Noncommercial 1.0.0. Copies you already received keep the license they came with.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.