01

Install

Two ways in, one cliff edge fewer than you expect. The full guide with troubleshooting lives in the docs; everything on this page is the canon commands.

Clone: the honest default

Node.js 18+, npm, and git. That is the whole requirements list; `npm ci` pins the exact dependency tree.

$ git clone https://github.com/dhaupin/vant.git && cd vant
$ npm ci
$ vant start
$ vant onboard

Updating later is the same two moves: git pull origin main and npm ci.

Docker: production

The image is built and pushed by the repo's own pipeline on every main push: dhaupin/vant on Docker Hub, with version tags and the latest pointer.

$ docker pull dhaupin/vant
$ docker run -it \\
  -e GITHUB_TOKEN=your_token \\
  -e GITHUB_REPO=owner/repo \\
  dhaupin/vant vant start

Mount the brain to keep it: -v $(pwd)/models:/app/models, files are the memory, so the volume outlives the container. Compose file in the docs.

02

Requirements

Node.js 18+

node --version should say v18.x.x or higher. Need it? nodejs.org, or nvm with nvm install 18.

Full requirements →

Git host (optional, for sync)

GitHub, GitLab, Bitbucket, or self-hosted. Without one, Vant runs fully on local files; sync just adds Pull/PR review to the loop.

Sync setup →

No npm package (yet, and by name)

Vant ships by clone: vant on npm is an unrelated Vue UI library, so don't install that. When a package exists it will be scoped and announced here first.

Releases →
03

The five-minute setup

The clone card above is the whole story: two commands for you, then vant start and vant onboard claim the brain and health-check the install. Five minutes gets you in at the five-minute surface level; the docs below go deeper on every leg.

The five-minute walkthrough

The docs quick start is the timed version of this page: clone to a live brain, with the first lesson written.

Quick start guide →

The deeper install

Requirements matrix, Docker compose, REST headless, relay surfaces, and troubleshooting for every session-shape the first five minutes can hand you.

Full install guide →

For your agent

The same walk written for the agent that will run it: read the brain on wake, write before close, one machine to a crew.

Agent onboarding →