Understand the codebase. Plan the change. Verify the result.
Evidence-grounded engineering intelligence for Java and Kotlin repositories.
Vericore is a local-first Kotlin/JVM tool that turns repository source, dependency structure, Git state, architecture signals, and grounded evidence into deterministic engineering context. It then uses that context to support repository Q&A, impact analysis, engineering plans, and a repository-bound prepare → change → verify workflow.
Core principle: deterministic repository evidence first; optional AI reasoning second.
Most code-change workflows answer two different questions:
Vericore keeps those questions connected.
| Stage | What Vericore provides |
|---|---|
| Understand | Source parsing, dependency graphs, cycles, PageRank hotspots, Git signals, architecture findings, Engineering Reality, and grounded evidence |
| Plan | Repository questions, change-impact signals, deterministic PR Intelligence, evidence-backed engineering plans, and a persisted Agent Change Contract |
| Verify | Repository identity, prepared Git HEAD, planned-path scope, change impact, architecture signals, and declared verification commands |
The planner is read-only. The persisted Agent Change Contract becomes the verification boundary used after the change.
The published platform archives bundle a Java runtime, so normal end-user use does not require a separate JDK.
Download a release from GitHub Releases, then verify the installed archive:
Windows: bin\vericore.bat --version
Linux/macOS: ./bin/vericore --version
For end users, V2 adds installers that select the published platform archive and verify its SHA-256 checksum before installation.
Linux x64 / macOS Intel / macOS Apple Silicon:
curl -fsSL https://raw.githubusercontent.com/sonii-shivansh/Vericore/main/scripts/install.sh | bash
Windows PowerShell (x64):
irm https://raw.githubusercontent.com/sonii-shivansh/Vericore/main/scripts/install.ps1 | iex
The installers use the latest published GitHub Release, verify SHA256SUMS, and install without requiring a separate JDK. The Unix installer uses a user-local directory by default; the Windows installer adds its user-local bin directory to the user PATH. Open a new shell after installation so PATH changes are picked up.
Supported V2 installer targets are Linux x64, macOS x64, macOS arm64, and Windows x64.
After installation, verify the local runtime immediately. You do not need to be inside a Git repository:
vericore doctor
To diagnose a specific repository, pass its path explicitly:
vericore doctor --path /path/to/repository
Doctor treats missing Git repository context and optional AI credentials as warnings; invalid diagnostic paths and runtime/configuration failures remain actionable failures.
git clone https://github.com/sonii-shivansh/Vericore.git
cd Vericore
./gradlew --no-daemon clean test
./gradlew --no-daemon installDist
./build/install/vericore/bin/vericore --version
vericore analyze /path/to/repository
The default HTML report is written to:
/path/to/repository/output/index.html
Create machine-readable repository-state artifacts when needed:
vericore evidence-graph /path/to/repository --json
vericore reality /path/to/repository --json
vericore repo-qa "Why is PaymentService risky?" --path /path/to/repository
repo-qa is deterministic retrieval over repository evidence. Optional provider-backed AI reasoning is a separate path.
Create the engineering context, plan, and persisted change contract:
vericore prepare "add payment validation" --path /path/to/repository
Make the code change, run the project’s normal tests, then verify the original persisted contract:
vericore verify --path /path/to/repository
The verification step checks the persisted contract rather than silently generating a replacement from a mutable plan.
For a faster boundary check, use:
vericore verify --path /path/to/repository --contract-only
Vericore exposes a local MCP stdio server for AI-agent workflows:
vericore mcp
The intended pattern is:
AI agent
│
│ understand / plan
▼
Vericore
│
│ repository-bound contract
▼
code change
│
│ verify
▼
Vericore
The MCP surface includes repository analysis, impact analysis, architecture intelligence, Engineering Reality, context snapshots/diffs, evidence, preparation, change safety, and verification.
See MCP and Change Safety for the exact protocol and safety boundaries.
Vericore currently provides:
The published release line is currently Vericore 0.8.2. The main branch may contain unreleased hardening after that release.
Vericore is intentionally local-first.
These are current product boundaries, not promises about future releases.
The complete command contract is maintained separately:
It documents the current commands, syntax, options, defaults, outputs, and important failure semantics.
Discover the surface directly:
vericore --help
vericore --version
flowchart TD
R[Repository + Git] --> A[Deterministic Analysis]
A --> C[Engineering Context]
A --> G[Semantic Evidence Graph]
C --> E[Engineering Reality]
G --> E
E --> I[Deterministic Intelligence]
I --> Q[Grounded Evidence]
G --> Q
Q --> P[Q&A / Planner]
Q --> V[Prepare / Verify]
V --> K[Agent Change Contract]
Q --> X[CLI / REST / MCP / CI]
K --> X
Q --> AI[Optional AI]
AI --> X
See Architecture for package boundaries, deterministic rules, and trust boundaries.
Recommended setup:
vericore setup
vericore doctor
The canonical project configuration file is .vericore.json. VERICORE_ALLOWED_PATHS controls server workspace boundaries. API keys must never be committed.
Vericore is local-first. Deterministic analysis does not require an external service. Provider-backed AI features receive only the bounded repository-derived context required by the invoked operation.
See Data & Privacy.
For source development:
./gradlew --no-daemon clean test
./gradlew --no-daemon build installDist
GitHub Actions is the authoritative clean-environment verification path for the repository. The release audit currently exercises builds/tests, CLI/MCP/REST surfaces, generated artifacts, prepare/verify safety boundaries, live repositories, onboarding, and cross-platform packaging.
See Contributing, Development, and Implementation Status.
| Topic | Document |
|---|---|
| Start here | Getting Started |
| Complete CLI reference | CLI |
| Architecture | Architecture |
| Change safety | Change Safety |
| Engineering Reality | Engineering Reality |
| MCP / AI agents | MCP |
| REST API | API |
| PR Intelligence | PR Intelligence |
| Data & Privacy | Data & Privacy |
| Implementation status | Implementation Status |
| Documentation hub | docs/INDEX.md |
| Contributing | Contributing |
| Security | Security |
Vericore is released under the MIT License. See LICENSE.