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 ≥ 22
  • A running n8n instance (local or remote) for integration and provider tests
  • 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
npm install

Build the project:

npm run build

Tests​

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

CommandWhat it runs
npm testUnit tests (fast, no external deps)
npm run test:integrationScenario integration test against a single LLM provider
npm run test:providersProvider matrix — all providers, always in advanced + strict mode

Development workflow​

After editing source files, rebuild before running tests:

npm run build
npm test

Use npm run typecheck to check types without rebuilding:

npm run typecheck