Install the Bri CLI and create an API key
The Bri CLI is the fastest path from a Markdown file to a public or private note. Homebrew is the recommended install method because it keeps upgrades owned by Homebrew.
Install bri
12brew tap egeuysall/tap brew install --formula egeuysall/tap/bri
Check the binary: run
bri --version after installation. The CLI can check for newer releases during normal commands; pass --no-update-check in automation.Create a key
- Sign in at bri.fyi with your Bri account.
- Open your profile dashboard and switch to Settings.
- Choose a label and the smallest permission set that fits the client.
- Select Generate, then save the full key immediately; Bri shows it once.
The three permission levels are
read, write, and read_write. Publishing, updating, deleting, inviting, and restoring require write access; listing and reading require read access. A key used to sign in through the browser must be read_write.Treat the key like a password. Do not paste it into a repository, issue, screenshot, or client-side code. Revoke it from Settings if it is exposed.
Save the key for the CLI
Use
bri login to save the key in the local Bri config file:1bri login --api-key 'bri_your-key-here'
The config lives at
~/.config/bri/config.json. For CI or a one-off command, prefer an environment variable so the key does not become part of the saved config:1export BRI_API_KEY='bri_your-key-here'
Verify the connection
Run the diagnostic command before publishing:
1bri doctor
If the command fails, check that the key is complete, has the required permission, and is not revoked.
BRI_ENDPOINT and BRI_SITE_URL can override the production defaults when you are testing a local Bri server.