Getting started
Install Sandbar and run your first task.
On this page
Sandbar is an invented tool, so nothing here installs for real. The steps show how a guide reads once the sample text is yours.
Install
Requirements
Sandbar needs Node 24 or later. Run node --version to check.
Write a task file
Create sandbar.yml at the root of your project:
tasks:
build:
run: npm run build
test:
run: npm test
after: [build]
The project now looks like this:
- my-project/
- sandbar.ymlthe task file
- package.json
- src/
Run a task
npx sandbar run test
Sandbar runs build first, because test lists it under after, then runs test.
What if a task fails?
Sandbar stops at the first failing task and exits with that task's exit code. Pass --keep-going to run the tasks that do not depend on it.
Next
Read the command reference and the configuration reference.