Quick Start

Use this guide to build vecgrep, register a project, index it, and run your first search.

Prerequisites

• Go 1.25 or newer
• Task for project commands
• Ollama with nomic-embed-text

ollama pull nomic-embed-text

Build vecgrep

git clone https://github.com/abdul-hamid-achik/vecgrep.git
cd vecgrep
task build

The binary is written to bin/vecgrep.

Initialize a Project

From any source repository:

cd /path/to/project
vecgrep init

By default, vecgrep registers the project globally and stores generated data under ~/.vecgrep/projects/<project>/. This avoids creating a repo-local .vecgrep/ directory.

Use local storage only when you need project-local state:

vecgrep init --local

Index Files

vecgrep index

For a full rebuild:

vecgrep index --full

Search

vecgrep search "error handling in HTTP requests"

Open the full-screen terminal workspace:

vecgrep studio

You can also use:

vecgrep browse

Verify Status

vecgrep status
vecgrep status --format json

Status includes the data directory, vector backend, provider, index counts, and embedding profile state.