Skip to content

Quickstart

This guide takes one task through the Tandem loop: install, initialize, add work, start and claim it, deliver it for validation, accept it, complete it into logs, and open the TUI.

The workflow below is CLI/TUI-only. Agent and editor integrations are optional; see Extensions when you are ready to connect them.

Choose the lane that matches your environment.

A curl/install.sh style installer is planned, but this repository does not currently document a shipped installer URL. Do not run a guessed install script. Use the Cargo lane for now.

If you have Rust and Cargo installed, install from the current tagged source:

Terminal window
cargo install --git https://github.com/Algorant/tandem.git --tag tandem-v0.4.0 --path tandem --locked
tandem --version

From a local checkout of this repository, use:

Terminal window
cargo install --path tandem --locked
tandem --version

An Arch/AUR binary lane is planned, but no AUR package name is currently documented in this repository. Do not install a guessed package name. Use the Cargo lane until the package is published and named.

Run this at the root of the project repository you want to coordinate:

Terminal window
tandem init --title "My Project"

Tandem creates .tandem/tandem.md, active board files in .tandem/board/, completed logs in .tandem/logs/, and lifecycle event logs. The default active task states are todo, in-progress, and validation.

Terminal window
tandem add --title "Write project brief" --description "Draft and validate the first docs slice."
tandem list
tandem show task-1

The task is a Markdown file with YAML frontmatter. You can read it in any editor, then use Tandem commands for safe state and accord updates.

Move the task into active work and claim the accord:

Terminal window
tandem move task-1 --state in-progress
tandem accord claim task-1 --assignee alice

Claiming from todo also moves a task to in-progress; the explicit move above is useful when you want the board state change to be visible before the accord claim.

After doing the work, record what changed and how it was checked:

Terminal window
tandem accord deliver task-1 \
--summary "Drafted the brief and checked the rendered docs" \
--deliverable "Updated docs/index.md" \
--validation "Ran cd site && bun run check:docs" \
--file-changed docs/index.md

Delivery moves the task to validation. The worker records evidence; a reviewer or orchestrator decides whether the delivery is accepted.

Inspect the delivered task:

Terminal window
tandem list --state validation
tandem show task-1

If the work is acceptable, accept the accord:

Terminal window
tandem accord accept task-1 --reviewer bob --summary "Looks good"

If it needs another pass, request rework instead:

Terminal window
tandem accord rework task-1 --note "Please add the install path and validation command."

After acceptance, archive the task as completed history:

Terminal window
tandem complete task-1 \
--summary "Published the project brief" \
--validation "Reviewed by Bob" \
--file-changed docs/index.md

The v0 CLI may warn when separate review.status metadata is missing. Treat that warning as a policy reminder: complete only when the responsible reviewer or orchestrator has intentionally accepted the work.

Search or inspect the completed log:

Terminal window
tandem log list
tandem log show task-1
tandem search "project brief"

Logs are first-class history, not trash. They preserve what shipped, why it was accepted, which validation evidence was available, and which files changed.

Use the terminal interface for day-to-day board work:

Terminal window
tandem tui

The TUI centers on the Board, including the todo, in-progress, and validation task states, plus Logs, Rules, and Decisions views.

  • Read Concepts for the mental model behind states, accords, validation, decisions, and logs.
  • Read CLI for the command families used by the quickstart.
  • Read TUI for keyboard, mouse, and theme behavior.