Skip to content

Latest commit

 

History

History
218 lines (159 loc) · 10.8 KB

File metadata and controls

218 lines (159 loc) · 10.8 KB
vera

Vera

License: MIT Rust GitHub release Languages

Install Guide · Features · Query Guide · Benchmarks · How It Works · Models · Supported Languages

Vector Enhanced Reranking Agent

Code search that combines BM25 keyword matching, vector similarity, and optional cross-encoder reranking. Supports 65 languages (61 with tree-sitter parsing), runs locally, returns structured results with file paths, line ranges, symbol metadata, and relevance scores.

v1.0

Vera 1.0 is the feature-complete milestone: the search pipeline, code-intelligence commands, agent integrations, and local inference backends are all in place, hardened by a wave of community PRs and user-reported fixes. Highlights include measured search-quality gains on the full 1,251-task Semble suite, an agent-level benchmark showing fewer input tokens at equal answer quality, structural search intents, git-scoped queries, the vera serve HTTP server, and local-mode hardening. See What's new in v1.0 for details.

Quick Start

1. Install

bunx @vera-ai/cli install   # or: npx -y @vera-ai/cli install / uvx vera-ai install

2. Set up and index (pick one)

vera setup                                  # Interactive, indexes this project by default
vera setup --potion-code --index .          # Default local model
vera setup --api --index .                  # Remote API mode, prompts for endpoint + key
vera setup --onnx-jina-coreml --index .     # Apple Silicon (M1/M2/M3/M4)
vera setup --onnx-jina-cuda --index .       # NVIDIA GPU
vera setup --onnx-jina-rocm --index .       # AMD GPU (ROCm, Linux)
vera setup --onnx-jina-openvino --index .   # Intel GPU (OpenVINO, Linux)
vera setup --onnx-jina-directml --index .   # DirectX 12 GPU (Windows)

3. Search

vera search "authentication logic"

If the current project has no index, interactive search offers to create one. JSON and non-interactive searches still return the missing-index error.

The default local embedding model is minishlab/potion-code-16M-v2. It runs locally on CPU on any supported machine; no GPU or ONNX Runtime needed. Jina ONNX and CodeRankEmbed are opt-in alternatives.

What Sets Vera Apart

Opt-in cross-encoder reranking Enable query-candidate scoring with retrieval.reranking_enabled when you need it. Reranking is off by default.
Single binary, 65 languages One static binary with 61 tree-sitter grammars compiled in. No Python, no language servers, no per-language toolchains.
Built-in code intelligence Call graph analysis, reference finding, dead code detection, and project overview, all from the same index.
Token-efficient for agents Returns symbol-bounded chunks, not entire files. 75-95% fewer tokens on typical queries.

Vera started after weeks of working on Pampax, a project I forked because it and other similar tools were missing what I wanted. I kept running into deep-rooted bugs, less-than-ideal design decisions, and thought I could build something better from the ground up. Every design choice comes from careful research, learning from other projects, benchmarking and evaluation. Take a look at the full feature list to see everything Vera can do.

Installation

Use the quick start above if you just want to get going. This section helps you pick the right backend.

bunx @vera-ai/cli install   # or: npx -y @vera-ai/cli install / uvx vera-ai install

Pick Your Backend

Vera itself is always local: the index lives in .vera/ per project, config and models in $XDG_DATA_HOME/vera (or ~/.vera for existing installs). The backend choice only affects where embeddings and reranking run.

You have Run this What happens
Not sure vera setup Interactive wizard auto-detects your hardware
CPU only vera setup --potion-code Uses the default minishlab/potion-code-16M-v2 local model on any supported machine
Remote models vera setup --api Prompts for an OpenAI-compatible endpoint and key
Apple Silicon (M1/M2/M3/M4) vera setup --onnx-jina-coreml Downloads local models, uses CoreML GPU acceleration
NVIDIA GPU vera setup --onnx-jina-cuda Downloads local models, uses CUDA. Fastest local option
AMD GPU (Linux) vera setup --onnx-jina-rocm Downloads local models, uses ROCm
Intel GPU (Linux) vera setup --onnx-jina-openvino Downloads local models, uses OpenVINO
DirectX 12 GPU (Windows) vera setup --onnx-jina-directml Downloads local models, uses DirectML

API mode works with any OpenAI-compatible endpoint and needs no local compute. Use vera setup --api --yes with EMBEDDING_MODEL_* variables for non-interactive setup. The default minishlab/potion-code-16M-v2 model runs locally on CPU on any supported machine; no GPU or ONNX Runtime needed. Jina ONNX and CodeRankEmbed are opt-in alternatives. Reranking is opt-in and disabled by default. After the first index, vera update . only re-embeds changed files, so incremental updates are fast on any backend. Full details: docs/models.md.

For step-by-step instructions, API provider options, Docker, building from source, and troubleshooting, see the full Installation Guide.

MCP server
vera mcp   # or: bunx @vera-ai/cli mcp / uvx vera-ai mcp

Exposes search_code, get_stats, get_overview, regex_search, structural_search, find_references, and explain_path. search_code, structural_search, and find_references auto-index and start a file watcher on first use if no index exists. The MCP surface stays intentionally small; use the CLI skill path when you need the full command set.

Usage

Core Workflow

vera search "authentication logic"
vera update .

Search Patterns

vera search "error handling" --lang rust
vera search "routes" --path "src/**/*.ts" --path "tests/**/*.ts"
vera search "handler" --type function --limit 5
vera search "OAuth token refresh" "JWT expiry handling" "auth middleware"
vera search "config" --intent "find where database connection strings are loaded"
vera search "config loading" --deep
vera search "auth" --compact
vera search "token validation" --changed
vera search "config loading" --base origin/main
vera structural definitions parse_config
vera structural env DATABASE_URL
vera structural routes --path "src/**/*.ts"
vera structural impls Loader
vera references parse_config --changed

Repeat --path to match any of several file path patterns. Path patterns use OR semantics; other filters still combine with AND semantics.

Common Tasks

Task Command
Regex or exact text vera grep "fn\s+main"
Common structural tasks vera structural routes / vera structural env DATABASE_URL / vera structural impls Loader
Explain why a file is missing from the index vera explain-path path/to/file
Inspect index health vera stats --json
Find callers vera references foo
Find callees vera references foo --callees
Find dead code vera dead-code
Get a project overview vera overview
Scope a search to changed files vera search "query" --changed
Keep the index fresh vera watch .
Run local HTTP inference server vera serve
Check your setup vera doctor
Repair missing local assets vera repair
Install agent skills vera agent install

See the query guide for search tips, the feature list for the full command surface, and vera --help for CLI details.

Output

Defaults to markdown codeblocks (the most token-efficient format for AI agents):

```src/auth/login.rs:42-68 function:authenticate
pub fn authenticate(credentials: &Credentials) -> Result<Token> { ... }
```

Use --json for compact JSON. --raw works with vera search, vera grep, and vera references; --timing works with vera search and vera grep. You can place them before or after the subcommand (for example, vera --timing search "auth" or vera references parse_config --raw).

Excluding Files

Vera respects .gitignore by default. Create a .veraignore file (gitignore syntax) for more control, or use --exclude flags. Details: docs/features.md.

If a file is missing from the index and you need the exact reason, run:

vera explain-path path/to/file

Benchmarks

Semble benchmark comparison, measured 2026-08-23 on 1,251 tasks across 63 repositories:

Tool nDCG@10 R@1 R@5 R@10 MRR Query p50 Index time Index size
Vera 0.8441 0.6711 0.9203 0.9514 0.8262 9.9 ms 174 s 4.7 GB
Semble 0.5.5, full rerank stack 0.8514 0.6747 0.9177 0.9656 0.8348 2.3 ms 100 s 32 GB

Both tools used the same minishlab/potion-code-16M-v2 embeddings, harness, graded relevance, and suffix-corrected path matching in the scorer. On the 320-task tuning subset, Vera scored 0.8540 versus Semble at 0.8494 nDCG. On the contamination-check independent set, Vera scored 0.7644 versus Semble at 0.7655. See docs/benchmarks.md for the screening tables and historical comparisons.

Full methodology and version history: docs/benchmarks.md.

Configure Your AI Agent

vera agent install installs the Vera skill for supported coding agents and can add a short usage snippet to your project's AGENTS.md, CLAUDE.md, COPILOT.md, or editor rules file.

vera agent install
vera agent install --client all

If you use the skills CLI, you can install Vera there too:

npx skills add VeraTools/Vera

If you skipped the prompt and want to add the instructions manually, use the snippet in the Installation Guide.

Contributing

See CONTRIBUTING.md.