Skip to content
Docs/Quickstart

Quickstart

Install the CLI, initialize memory, and push your first snapshot in under 10 minutes.

You'll need

  • A git repo for your project.
  • A vem API key from the dashboard.
  • Node 18+ and a terminal.

You'll get

  • A local .vem/ memory layer (gitignored by default).
  • Cloud snapshots indexed for search.
  • Agent tools via MCP when you're ready.

Setup in 5 steps

01Step

Install the CLI

Use npm or pnpm to install the vem CLI.

npm install -g @vemdev/cli
02Step

Initialize memory in your repo

vem creates local memory files under .vem/, adds .vem/ to .gitignore, and can install a pre-push hook for auto-syncing.

cd /path/to/your-repo
vem init
03Step

Authenticate and link your project

Log in (key or browser) and link the repo to a project.

Grab your API key from API Keys and create projects in Projects.

vem login
vem link [project-id]
04Step

Commit code, then push your first snapshot

Keep .vem/ local and gitignored. Push a snapshot before git push so webhook verification can match the commit.

git add .
git commit -m "ship feature"
vem push
git push
05Step

Launch your first agent session

Use vem agent to start AI-assisted work with automatic context and task tracking.

The agent command will:

  • Help you select or create a task
  • Generate context files automatically
  • Wrap your AI tool with memory enforcement
  • Track completion and validation

vem agent

Sync across machines

When you move to a new machine, pull the latest verified snapshot and continue from local .vem/ state.

vem pull
vem push

Connect agents (MCP)

vem exposes MCP tools so agents can read tasks, search memory, and record decisions.

Start the MCP server and connect it in your agent client.

npx vem-mcp

Next steps