Skip to main content

Contributing

This guide covers how to get Yagr running locally for development and how to run the test suite.

Prerequisites

  • Node.js ≥ 24
  • pnpm via Corepack
  • At least one LLM provider configured (API key or OAuth account)

Local setup

Clone the repository and install dependencies:

git clone https://github.com/EtienneLescot/yagr.git
cd yagr
corepack enable
pnpm install

Build the project:

pnpm run build

Tests

Yagr has three test levels. See Testing for full details.

CommandWhat it runs
pnpm testUnit tests (fast, no external deps)
pnpm run test:packagesPackage-level tests
pnpm run test:unitRoot unit tests after build

Development loop

After editing source files, rebuild before running tests:

pnpm run build
pnpm test

Use pnpm run typecheck to check types without rebuilding:

pnpm run typecheck