Get Started

Prerequisites

• Node.js 20 or newer for the one-time npx installer
• A Git repository

Install the CLI

Install EVE once for the current user and configure Codex, Claude Code, and opencode:

npx @nhestrompia/eve@latest install

The installer selects the correct GitHub Release binary, verifies its checksum and version, and configures MCP clients with the absolute binary path. It prints PATH guidance when the user installation directory is not already available to the shell.

To configure selected clients or skip MCP configuration:

npx @nhestrompia/eve@latest install --clients codex,claude
npx @nhestrompia/eve@latest install --no-mcp

Initialize a repository

From any Git repository:

eve init
eve doctor

Initialization creates .eve/ and installs a managed EVE guidance block in both AGENTS.md and CLAUDE.md. Existing instructions remain untouched outside the EVE markers. Review and commit these repository-level files with the rest of your setup.

Start eve

Start the local UI, API, and HTTP MCP endpoint:

eve

Open http://localhost:4317.

Run from this checkout

Contributors working on EVE itself also need Go 1.26 or newer. Run the embedded UI and CLI directly from the repository source with:

npm --prefix ui ci
npm --prefix ui run build
go run ./cmd/eve init
go run ./cmd/eve

EVE opens http://localhost:4317 and, on macOS, opens the installed approval app when it is available.

To stop the local runtime:

go run ./cmd/eve kill

You do not need to run the docs site for normal local use. The docs site is only for documentation edits.

Confirm the version

eve version

Create the first snapshot

Create a snapshot after the product change is implemented and verified:

eve add \
  --title "Add GitHub OAuth" \
  --type feature \
  --summary "Users can now sign in with GitHub." \
  --user-visible-change "The login screen now includes a GitHub sign-in option." \
  --validation "go test ./..."

eve commit

The committed snapshot appears under .eve/snapshots/. Commit that generated file to Git so the product record travels with the repository.