Install the Buron CLI

The Buron CLI is how you bring Buron into the places you already work. It connects to your AI editor (Claude Code, Cursor, Codex) and your CI pipelines (like GitHub Actions). Once you've installed and linked it to your team, your editor's agent picks up Buron skills automatically, and your CI jobs can read and write your team's docs in Buron.

You only do this setup once per machine and once per project.

Before you begin

You'll need Node.js 18 or later, plus either npm or pnpm. To check which version of Node you have, run node --version.

Install the CLI

Pick the package manager you use, then run the matching command.

npm install -g @buron/cli

pnpm add -g @buron/cli

To confirm it worked, run buron --version. You should see a version number.

The CLI uses a browser-based device flow, so you don't have to type or store a password. To sign in, run:

buron login

We'll print a short user code and open the sign-in page in your browser. Once you confirm the code, the CLI finishes signing you in automatically. To sign out later, run buron logout.

Link a project

Move into the project folder you want to connect, then run:

buron link

We create a .buron/config.json file with your org and team IDs, so future commands know where to send and read data. We also drop slash commands into your editor's skills folder. Your editor's agent uses those to talk to Buron.

Most teams commit .buron/config.json so teammates don't have to re-link the project. To keep it local, add .buron/ to your .gitignore.

Do it all at once

To install, sign in, and link in a single step, run:

buron setup

This walks through everything in order. It's the fastest way to get set up on a fresh machine.

Next steps

With the CLI installed and your project linked, check out Use Buron in your AI editor. To automate things in CI as well, check out Run Buron from CI.