Documentation

Quickstart: your first goal

This walks you from a fresh install to a completed goal. Assumes Claude Code is installed and logged in (see Install).

1. Launch + onboarding

Open Veyandor. The first launch shows the onboarding wizard:

  1. Welcome → Get started.
  2. Connect — Veyandor starts its bundled daemon and connects to it automatically. (If it stays disconnected, see Troubleshooting.)
  3. Claude Code — Veyandor checks that claude is installed and looks logged in. Use Test connection to verify against your subscription. If it isn't detected, install Claude Code and run claude → /login, then re-check.
  4. Add your first project — click Browse… and choose a folder. It must be a Git repository — if it isn't, run git init in it first (or pick an existing repo). Veyandor works on git repos so it can branch, isolate, and merge agent work safely.
  5. License — Skip for now (Veyandor is a paid product, but you can add a key later in Config → License; nothing is gated yet).
  6. Done → Start your first goal.

You can re-open this wizard any time from the Setup button in the top bar.

2. Start a goal

In the cockpit, open the Control panel:

  1. Pick your project.
  2. Type a goal — describe what you want built, in plain language (e.g. "Add a /health endpoint that returns uptime and version, with a test.").
  3. Choose dependency mode (start with summary) and land mode (start with review, so nothing merges without you).
  4. Start.

3. Watch it work

Veyandor plans the goal, breaks it into tasks, and dispatches coding-agent sessions:

  • Sessions / Task DAG widgets show tasks planning → running → done.
  • Open a session to watch its output; open a Terminal, the Editor, or the Browser panel to inspect the worktree.

With land mode review, the work lands on an integration branch for you to review and merge.

4. Where to go next

  • Budgets — set a monthly spend cap per project or globally (Config).
  • Overseer — chat with a per-project conductor that can plan and propose actions; switch it between supervised and autonomous.
  • Isolation — run a project's agents in Docker containers (Config → isolation).
  • Skills & plugins — teach Veyandor reusable procedures and connect MCP tools.
  • Updates — Config → Updates → Check for updates (manual; Veyandor never checks in the background).

Veyandor stores everything locally under ~/.veyandor.