CLI

Run Buron from CI

Run the Buron CLI in GitHub Actions and other CI pipelines to keep Buron in sync with what your codebase ships.

The other place teams run the CLI is from CI, usually to keep Buron in sync with what's happening in the codebase. A common setup is snapshotting your changelog or release notes when something ships, so the Agent has the latest context the next time someone asks. Other teams use it to publish reports on a schedule, or to mirror docs from one place to another.

You can run the CLI on whichever CI provider you use. The only thing that's different from local is how you sign in.

Get a CI token

Mint one from your logged-in CLI, in the repo linked to the right team:

buron token create

The token is shown exactly once. Store it straight into your repo's secrets:

gh secret set BURON_TOKEN

Manage tokens later with buron token list and buron token revoke <id>.

Treat your CI token like a password. Add it as a secret in your CI provider, and never paste it into a commit, log, or pull request.

Sign in with the token

Set the token as the BURON_TOKEN environment variable, and the CLI uses it instead of trying to open a browser:

export BURON_TOKEN="brnci_..."

Once it's set, every buron command in that job runs against your team.

A workflow you can copy

Here's a small example that snapshots your CHANGELOG.md to Buron every time you push to main:

name: Buron snapshot

on:
  push:
    branches: [main]

jobs:
  snapshot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install -g @buron/cli
      - run: buron file write /snapshots/$(date +%Y-%m-%d).md --from-file CHANGELOG.md
        env:
          BURON_TOKEN: ${{ secrets.BURON_TOKEN }}

The pattern is the same on any CI provider. Install the CLI, set BURON_TOKEN, then run whatever Buron commands you'd like: buron file write for content, buron datasets query --json for data.

Filing launch sources from CI

If you want every PR captured as a Buron source automatically, that's the /automate-launch skill's job: it can set up an editor automation or write a CI workflow that runs your coding agent against the /launch skill. See Automate launch filing.

Was this page helpful?

On this page