Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
46 changes: 13 additions & 33 deletions docs/RELEASING-bl.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Loading