☕ CoffeeBreak CLI Installation Guide
Get the CoffeeBreak CLI running on your device with signed installers, a one-line bootstrap script, and post-install validation. This guide complements the in-app onboarding quick-start card so workspace owners can share the same download links with their teams.
Downloads
| Platform | Installer | Checksum | Notes |
|---|---|---|---|
| macOS (Apple Silicon) | CoffeeBreakCLI-macos-arm64.pkg | SHA256 | Signed package adds /usr/local/bin/coffeebreak to PATH and installs the required .NET runtime. |
| macOS (Intel) | CoffeeBreakCLI-macos-x64.pkg | SHA256 | Identical experience to Apple Silicon package. |
| Windows 64-bit | CoffeeBreakCLI-win-x64.msi | SHA256 | MSI registers the CLI in Add/Remove Programs and updates PATH. |
| Linux (glibc) | coffeebreak-cli-linux-x64.tar.gz | SHA256 | Extract to /opt/coffeebreak (or preferred location) and run the bootstrap script below. |
| Linux (musl) | coffeebreak-cli-linux-musl-x64.tar.gz | SHA256 | Alpine-compatible build for musl-based distributions. |
ℹ️ The download links always point to the latest stable release. For pinned builds, replace
latestwith a semantic version (for example,v1.6.0). Seecoffeebreak package manifestfor published version metadata.
Quick bootstrap (Linux & macOS)
Run the signed bootstrap script when you need a one-line install for sandbox machines:
curl -fsSL https://downloads.coffeebreakai.dev/cli/latest/install.sh | bash
The script performs the following:
- Detects the host architecture and fetches the matching archive or package.
- Verifies the SHA256 checksum before installing.
- Installs the .NET runtime when it is missing.
- Adds the CoffeeBreak CLI directory to your shell profile.
- Offers to sign in with a workspace access token for first-run convenience.
Verifying your installation
After installation, confirm connectivity and agent availability:
coffeebreak doctor run --workspace example --environment production
The command validates authentication, enumerates enabled agents, and reports any policy mismatches. Review CoffeeBreak CLI Doctor for full diagnostics coverage.
Updating to newer releases
- Re-run the bootstrap script or installer—existing binaries are replaced in place.
coffeebreak package manifestemits release metadata, including build hashes and signing certificates.- Automation pipelines can call
scripts/package-cli.shto rebuild artifacts with custom branding or internal signing keys while emitting a signed manifest for compliance checks.【F:scripts/package-cli.sh†L1-L105】
Troubleshooting
| Symptom | Resolution |
|---|---|
coffeebreak not found after install |
Ensure your shell profile sources /etc/profile.d/coffeebreak.sh (macOS/Linux) or reopen your terminal so the PATH changes apply (Windows). |
| TLS errors when fetching packages | Confirm your proxy trusts CoffeeBreak's signing certificate chain and that outbound traffic to downloads.coffeebreakai.dev is permitted. |
coffeebreak doctor run fails with authentication errors |
Generate a new workspace access token from Admin → Version control and set COFFEEBREAK_ACCESS_TOKEN. |
Need additional help? Visit the in-app Support page or email support@coffeebreakai.dev with the installer log located at
~/.coffeebreak/logs/install.log (macOS/Linux) or %PROGRAMDATA%\CoffeeBreak\Logs\install.log (Windows).