Onboarding

Generated from 'wiki-onboarding.ts' on 2026-09-10, 07:04:46 UTC (v2.15.8, R v4.6.1), do not edit directly.

To get started developing on flowR, we recommend carefully reading the following pages:

• 💻 Setting up the flowR development environment.
  This page explains how to install R and Node.js.
• 💖 Contributing guidelines.
  This page also includes information about how to set up git-lfs and several git hooks.

Once you are set up, these pages explain the parts you are most likely to touch:

• 🔬 Core walks through the pipeline from parsing to the dataflow graph.
• 🖥️ Interface covers the REPL, the server, and the API.
• 🧪 Linting and Testing explains which tests exist and how to run them.

If you have any questions, please check out the FAQ first, but if the question is not answered there (or in the wiki in general), feel free to ask a question. The FAQ also includes information about how you can configure your editor.

After installing R and Node.js, a single command sets everything up:

npm run setup:dev

It installs the dependencies, checks your node version, tells you whether R and git-lfs are available, configures the git hooks, tests them, and closes with the pages and commands you will need next. Missing R or git-lfs are reported as notes instead of aborting the setup, so you can start with the tree-sitter engine right away and add them later.

If you want to execute the steps manually, please follow the instructions below:

# Installing git-lfs for your current user (if you haven't already)
git lfs install
# Cloning the repository
git clone https://github.com/flowr-analysis/flowr.git
# Installing dependencies
npm ci
# Configuring git hooks
git config --local core.hooksPath .githooks/
# Test if the git hooks are working correctly
# Running this command should lint the code
git push --dry-run