Configure the CLI
Configure the Buron CLI with project files and environment variables.
The Buron CLI gets its settings from two places: a project file that lives in your repo, and a personal auth file on your machine. You can also set a few environment variables to point the CLI at a different backend or use mock data.
Your project's config file
When you run buron link, we create a file at .buron/config.json in your project. It records your Buron organization, the team this project belongs to, and the API URL the CLI talks to.
Most teams commit this file so everyone on the project shares the same settings. To keep it local, add .buron/ to your .gitignore.
Your personal auth file
Your access token lives in a separate file, scoped to your user account on the machine. On macOS, it's ~/Library/Application Support/com.buron.cli/auth.json. On Linux, it's ~/.config/com.buron.cli/auth.json.
Each person on your team signs in separately, so this file is yours alone. Don't share or commit it.
Environment variables
Most of the time you won't need these, but a few situations call for them.
| Variable | When to use it |
|---|---|
BURON_TOKEN | When you can't sign in interactively, like in a CI job. |
BURON_EMAIL | Sets the display name shown for CI runs. |
BURON_API_URL | Points the CLI at a non-default API, useful for testing. |
BURON_MOCK | Returns canned responses, useful for offline development. |
If BURON_TOKEN is set, the CLI uses it instead of your auth.json file.
Was this page helpful?