Skip to main content

Installation

Paddles runs as a local-first binary. The recommended path uses Nix for reproducible builds.

Prerequisites

  • Nix with flakes enabled
  • A workspace directory you want to use as the project root

Enter The Dev Shell

nix develop

This provides the Rust toolchain, model dependencies, and build tools.

Build And Test

just build
just test
just quality

just quality runs Rust formatting, Rust linting, and the shared frontend workspace lint/typecheck path. just test runs the Rust test suite, the frontend workspace unit/build path, and browser E2E for both the docs app and the shipped TanStack runtime on /, /transit, and /manifold.

Verify The Binary

paddles --help

You should see the CLI help with options for --model, --planner-model, --prompt, --cuda, and --verbose.

--verbose is cumulative:

  • no flag => level 0, the default operational stream
  • -v => level 1, adds info-tier planner and synthesis metadata
  • -vv => level 2, adds debug-tier routing and capability detail
  • -vvv => level 3, enables trace diagnostics

You can also set verbose = 0, 1, 2, or 3 in paddles.toml. CLI flags override config, and the resolved level applies equally to the TUI transcript and the web event stream.

  • First Turn — run your first interactive session