Vupt Docs
Getting started

Quick Start

Five-minute walkthrough from install to your first Squad with two parallel agents writing real code.

Quick Start

This walkthrough takes about five minutes. By the end you will have a Squad of two parallel agents working in isolated git worktrees, each producing a diff you can review and merge.

1. Open Vupt and add a project

Launch Vupt. Click Add Project and point at any local git repository. Vupt registers the path; nothing leaves your machine yet.

2. Configure a provider (BYOK)

Open Settings → Providers and add at least one provider key:

# Example ~/.vupt/config.toml entry written by the UI
[providers.anthropic]
api_key_keychain_ref = "vupt/anthropic"
default_model = "claude-sonnet-4-5"

Keys are stored in your OS keychain (Keychain on macOS, Credential Vault on Windows, libsecret on Linux). Vupt never reads or persists the raw key value to disk.

3. Create your first Squad

From the project view, click New Squad. Give the Squad a goal (add a /healthz endpoint with tests), then add two tasks:

  • Task 1: prompt Add the route handler in src/api/health.ts, agent claude-code
  • Task 2: prompt Add the integration test for /healthz, agent codex

Hit Launch. Vupt creates one git worktree per task and spawns both agents in parallel.

4. Watch the journal

Each task streams its agent log into the journal pane. You can scroll, search, or follow live. Vupt persists every entry to the local SQLite database so you can replay later.

5. Review and merge

When both tasks complete, open the Diff Viewer and approve, discard, or request a follow-up turn per task. Approving runs your configured post-completion hooks (lint, test, build) and offers to open a Pull Request.

That is it — you ran a Squad. Next, read Configuration to tune defaults or jump to Concepts → Squads for the mental model.

Vupt — Run parallel AI coding agents