From 76743b26a2f355969b9cc2249a36601799c91a1a Mon Sep 17 00:00:00 2001 From: Nathan Thillairajah Date: Wed, 23 Sep 2026 12:16:10 -0400 Subject: [PATCH] Clarify standalone CLI distribution plans Signed-off-by: Nathan Thillairajah --- AGENTS.md | 2 +- README.md | 9 ++++----- docs/RELEASING-bl.md | 46 +++++++++++++------------------------------- 3 files changed, 18 insertions(+), 39 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 98373f4..3781d50 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -79,7 +79,7 @@ sq agent-tools linear --help - `docs/sq-overview.md` covers the repo and packaged CLI at a high level. - `docs/sq-integration.md` covers how `sq` discovers and integrates the packaged module. - `docs/RELEASING-sq.md` covers the Homebrew-backed `sq` command-pack release path. -- `docs/RELEASING-bl.md` covers building the `bl` CLI binary consumed by Berd.app. +- `docs/RELEASING-bl.md` covers building `bl` and the current distribution status. External docs: https://clig.dev/llms.txt -> guide you can consult to write better command-line programs, taking traditional UNIX principles and updating them for the modern day. diff --git a/README.md b/README.md index 56b5432..ff73d2b 100644 --- a/README.md +++ b/README.md @@ -137,11 +137,10 @@ just build-bl-release target/release/bl --version ``` -This repository owns the `bl` binary. Application packaging and the installed -command link are managed by the consuming BuilderLab application; this repo -does not provide standalone installers or platform archives. See -[RELEASING-bl.md](docs/RELEASING-bl.md) for the release boundary and packaging -integration. +This repository owns the `bl` binary, which can be used independently of Berd +or Buzz. Standalone downloads and app-assisted installation or updates are +planned; for now, build from source. See [RELEASING-bl.md](docs/RELEASING-bl.md) +for the current build and distribution status. ## Contributing diff --git a/docs/RELEASING-bl.md b/docs/RELEASING-bl.md index 99f8520..cc8de0c 100644 --- a/docs/RELEASING-bl.md +++ b/docs/RELEASING-bl.md @@ -1,12 +1,12 @@ -# Building `bl` +# Building and distributing `bl` -`bl-cli` owns the Rust `bl` binary. It no longer owns standalone app, -installer, archive, DMG, MSI, package, or platform-specific distribution. -Berd.app bundles the `bl` binary and manages the `/usr/local/bin/bl` command -link from the app. +This repository owns the BuilderLab CLI. It can be built and used independently +of Berd or Buzz. The intended distribution options include standalone downloads +and installation or updates assisted by those applications. The release and +update mechanisms are still being worked out. The Homebrew-backed `sq` command-pack release path is separate and documented in -`docs/RELEASING-sq.md`. +[RELEASING-sq.md](RELEASING-sq.md). ## Local Build @@ -31,32 +31,12 @@ target/release/bl --version target/release/bl --help ``` -## Berd Integration +## Distribution status -Berd packages `bl` by copying a built binary into the app resources during the -Berd bundle flow. In the parent app repo, this is handled by: +For now, build `bl` from source using the commands above. This repository does +not yet provide a standalone installer or published binary release workflow. -```text -scripts/prepare-bl-cli-resource.sh -``` - -The packaged app exposes the command from: - -```text -Berd.app/Contents/Resources/bl -``` - -Berd.app owns installing or repairing: - -```text -/usr/local/bin/bl -> /Applications/Berd.app/Contents/Resources/bl -``` - -## Ownership - -Do not add standalone `bl` app, installer, platform archive, DMG, MSI, package, -or Homebrew distribution back to this package. Distribution flows through -Berd.app. - -When changing `bl`, update and merge the version in `Cargo.toml`, run the normal -`bl-cli` checks, and validate the Berd bundle path that consumes the binary. +Future distribution should support users who want BuilderLab capabilities +without installing Berd or Buzz. App-assisted installation and updates are +also planned; packaging, signing, installation paths, and update behavior +are not specified here yet.