Documentation

# 1. install the CLI (macOS / Linux)
$ curl -fsSL https://get.buildkit.dev | sh

# 2. authenticate & link your repo
$ buildkit login
→ opening browser… authenticated ✓

# 3. scaffold a pipeline for this repo
$ buildkit init
→ detected node 20 · wrote buildkit.yml

# 4. push and run
$ git push
→ pipeline #1 queued · live at app.buildkit.dev

buildkit <command> [options]

  init            scaffold a buildkit.yml for this repo
  run             trigger a pipeline (--local, --cache)
  logs            stream live logs for a run
  secret set      add an encrypted, scoped secret
  runner install  register a self-hosted runner
  cache prune     clear cached artifacts for a branch
  status          show the latest pipeline result

version: 1
stages: [install, test, build, deploy]

cache:
  key: "deps-{{ hashFiles('package-lock.json') }}"
  paths: [node_modules, .next/cache]

jobs:
  test:
    stage: test
    matrix: { node: [18, 20, 22] }
    run: npm ci && npm test -- --shard=$SHARD

  build:
    stage: build
    needs: [test]
    run: npm run build

  deploy:
    stage: deploy
    needs: [build]
    when: branch == "main"
    secrets: [DEPLOY_KEY]
    run: buildkit deploy ./dist