Development Setup

    Start from the repo root

    Install Git, Node.js 22.19.0 or newer, and any pnpm 12 release. The root manifest is the authority for the supported versions. Corepack cannot run pnpm 12 yet, so install pnpm with another method from that page.

    pnpm install
pnpm build
pnpm dev

    pnpm dev starts the desktop development process. Keep it running while you use the source build. Press Ctrl+C to stop it.

    Common contributor checks

    pnpm typecheck
pnpm build
pnpm test
pnpm test:ci
pnpm eval:snapshot

    What those commands mean today

    • pnpm typecheck — workspace typecheck across packages and desktop Electron TS
    • pnpm build — workspace build
    • pnpm test — workspace test tasks
    • pnpm test:ci — typecheck, build, workspace tests, and the desktop contract E2E project
    • pnpm eval:snapshot — fast prompt assembly/cache drift check

    For live provider evals, use pnpm eval or pnpm eval:file-tools only when credentials and budget are available. See Running Evals and Testing / Evals.

    Runtime notes

    • Host is the default runtime on supported platforms.
    • Apple Container and Docker / Podman are explicit runtime choices when you want container-provided tools, isolation, or container networking behavior.
    • If native terminal support breaks, use the node-pty troubleshooting guidance from the repo docs.

    Evals

    Evals are a separate signal from typecheck/build/unit/e2e tests. Snapshot evals are fast and do not make live LLM calls. Full evals use promptfoo with real providers and may cost money.

    Start with Running Evals for the task flow, then use Testing / Evals for exact commands and scenario coverage.

    Contributor guidance

    For contribution workflow, PR expectations, and security reporting, see the root OSS files in the repository: