Install and authenticate the CLI¶
Use the CLI when you want repeatable commands, local pipeline validation, or Git-based workflow automation. The UI tutorial does not require it.
Install with Go¶
The shortest supported tutorial install uses Go 1.26 or later:
go install github.com/Braidplane/cli/cmd/braidplane@v0.1.0-alpha.4
Go installs the executable in $(go env GOPATH)/bin by default. Add that
directory to your PATH if necessary, then verify the command:
export PATH="$(go env GOPATH)/bin:$PATH"
braidplane --help
Pinning the version makes the tutorial reproducible. Advanced users who do not want a Go toolchain can install a signed archive from the CLI releases.
Create a personal access token¶
- Sign in to the app and open Account → Security → Personal access tokens.
- Create a token for your account.
- Copy it when shown. Braidplane does not display it again.
Keep the token out of shell history:
export BRAIDPLANE_SERVER_URL='https://api.staging.braidplane.com'
export BRAIDPLANE_ORG='<your-workspace-slug>'
read -r -s -p 'Personal access token: ' BRAIDPLANE_PAT
printf '\n'
export BRAIDPLANE_PAT
braidplane login
unset BRAIDPLANE_PAT
braidplane organization get
The server URL is the API URL, not the app URL, and has no /api suffix.
braidplane login stores the token in your operating system credential store.
Browser and CLI sessions are separate. If secure credential storage is
unavailable, contact the team instead of enabling plaintext storage.