Skip to content

Document formula-scoped Homebrew install #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crimson-knight merged 1 commit into from
Jul 31, 2026
Merged

Document formula-scoped Homebrew install #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,17 @@ Prerequisites: Crystal 1.20 or newer (but earlier than 2.0), `shards`, and Git.

### Homebrew on macOS or Linux

The tap name contains an underscore; the formula is named `amber`:
The tap and formula names contain underscores; the installed executable is
`amber`:

```bash
brew tap amberframework/amber_cli
brew install amber_cli
brew install amberframework/amber_cli/amber_cli
amber --version
```

The fully qualified command follows Homebrew's tap-trust model and trusts only
the `amber_cli` formula.

### Direct release archive

Use `darwin-arm64` on Apple Silicon macOS or `linux-x86_64` on x86_64 Linux:
Expand Down
3 changes: 1 addition & 2 deletions RELEASE_NOTES_V2.0.2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Amber CLI 2.0.2 is the supported standalone CLI for Amber
## Install

```bash
brew tap amberframework/amber_cli
brew install amber_cli
brew install amberframework/amber_cli/amber_cli
amber --version
```

Expand Down
8 changes: 6 additions & 2 deletions scripts/check_beta_contract.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ test "$cli_version" = "$shard_version"
grep -F 'github: amberframework/amber' src/amber_cli/commands/new.cr
grep -F 'version: 2.0.0-beta.2' src/amber_cli/commands/new.cr
grep -F 'template: ecr' src/amber_cli/commands/new.cr
grep -F 'brew tap amberframework/amber_cli' README.md
grep -F 'brew install amber_cli' README.md
grep -F 'brew install amberframework/amber_cli/amber_cli' README.md

if grep -Ein 'brew tap amberframework/amber_cli|brew install amber_cli' README.md RELEASE_NOTES_V2.0.2.md docs/*.md; then
echo "Amber CLI docs contain an untrusted or incomplete Homebrew install path" >&2
exit 1
fi

if grep -Eir 'crimson-knight/(amber|grant|gemma)' src/amber_cli/templates/app src/amber_cli/commands/new.cr; then
echo "supported web template contains a personal dependency" >&2
Expand Down
Loading