Language

Getting started

Install Sandbar and run your first task.

Trust: Unreviewed
Examples
Not recorded
Drift
Not recorded
Last reviewer
No reviewer recorded

Why this level

  • No review is recorded for this page, so its evidence has not been checked by a reviewer.

1 minute read

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

npm

npm install --save-dev sandbar

pnpm

pnpm add --save-dev sandbar

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.

View Markdown

Use with an agent
View Markdown

Open in