Skip to main content

Quickstart

Get Vagaris running locally in under 5 minutes.

npx @vagarylabs/vagaris onboard --yes

This walks you through setup, configures your environment, and gets Vagaris running.

If you already have a Vagaris install, rerunning onboard keeps your current config and data paths intact. Use vagaris configure if you want to edit settings.

To start Vagaris again later:

npx @vagarylabs/vagaris run

Note: Install the CLI globally (npm install -g @vagarylabs/vagaris) to get a plain vagaris command; npx @vagarylabs/vagaris works without installing. See the CLI section for the full first-task walkthrough.

Local Development​

For contributors working on Vagaris itself. Prerequisites: Node.js 20+ and pnpm 9+.

Clone the repository, then:

pnpm install
pnpm dev

This starts the API server and UI at http://localhost:3100.

No external database required — Vagaris uses an embedded PostgreSQL instance by default.

When working from the cloned repo, you can also use:

vagaris run

This auto-onboards if config is missing, runs health checks with auto-repair, and starts the server.

What's Next​

Once Vagaris is running:

  1. Create your first company in the web UI
  2. Define a company goal
  3. Create a CEO agent and configure its adapter
  4. Build out the org chart with more agents
  5. Set budgets and assign initial tasks
  6. Hit go — agents start their heartbeats and the company runs

Core Concepts

Learn the key concepts behind Vagaris