add bbin install docs

This commit is contained in:
Adam Jeniski 2026-01-05 02:47:23 -05:00
parent 02922ccc55
commit b6c05ced0a

View File

@ -37,6 +37,30 @@ A CLI tool for making commits to many subrepos after a distributed change.
## Installation
### Using bbin (Recommended)
Install directly from Gitea using SSH:
```bash
# Install from your Gitea repository via SSH
bbin install git@git.ajet.fyi:ajet-industries/commitly.git
# Install a specific version using a git tag
bbin install git@git.ajet.fyi:ajet-industries/commitly.git --git/tag v1.0.0
# Install the latest commit
bbin install git@git.ajet.fyi:ajet-industries/commitly.git --latest-sha
```
This will install `commitly` to `~/.local/bin/commitly` (make sure `~/.local/bin` is in your PATH).
**Note:** Requires [bbin](https://github.com/babashka/bbin) to be installed first:
```bash
bash < <(curl -s https://raw.githubusercontent.com/babashka/bbin/main/bbin)
```
### Manual Installation
```bash
# Make the script executable
chmod +x commitly