Install the CLI

Install @backfill-io/cli, point it at your workspace, ship.

The @backfill-io/cli package handles scaffolding, dev mode, and deploys. One install and you’re set.

Install

npm install -g @backfill-io/cli

Or with whatever package manager you prefer:

pnpm add -g @backfill-io/cli
yarn global add @backfill-io/cli

Verify:

backfill --version

Point it at your workspace

The CLI reads its server URL and API token from a .backfillrc file. It walks up the directory tree to find one — so a single file at the root of your integrations monorepo covers every project under it.

# .backfillrc — DO NOT commit
server = https://api.backfill.io
token  = bf_...

Precedence (highest wins):

CLI flags: --server, --token
Env vars: BACKFILL_SERVER, BACKFILL_TOKEN
A .backfillrc in the project directory
A .backfillrc in any parent directory

Verify auth:

backfill auth

If something’s off, the CLI exits non-zero and tells you exactly what.

What you can do with it

Command	What it does
`backfill init <name>`	Scaffold a new extension project.
`backfill build`	Validate the manifest and every script. No deploy, no network.
`backfill dev`	Watch your files. Auto-deploys a draft on save.
`backfill deploy`	Build, validate, upload, activate. `--observe` to dry-run against live traffic.
`backfill versions`	List deployed versions.
`backfill rollback --to <id>`	Roll back to a prior version.
`backfill logs [--follow]`	Stream extension logs.
`backfill trigger`	Manually fire a hook for testing.
`backfill promote`	Turn an `--observe` deployment into the live one.
`backfill job list` / `run <name>`	Inspect or kick off a scheduled job by hand.
`backfill auth`	Show or verify the active credentials.

Five-minute first ship → Quickstart.

← Quickstart

Install the CLI

Install

Point it at your workspace

What you can do with it

Next