Skip to content

Document formula-scoped Homebrew install #1397

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 #1397

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
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,7 @@ Read Amber documentation on https://docs.amberframework.org/amber
Install the standalone CLI with Homebrew on macOS or Linux:

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

Expand Down
3 changes: 1 addition & 2 deletions RELEASE_NOTES_V2_BETA1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ it for production workloads that cannot tolerate them.
Install Amber CLI 2.0.2 or newer:

```bash
brew tap amberframework/amber_cli
brew install amber_cli
brew install amberframework/amber_cli/amber_cli
amber new my_app --type web
cd my_app
crystal spec
Expand Down
3 changes: 1 addition & 2 deletions RELEASE_NOTES_V2_BETA2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ It keeps the same public beta surface and fixes application startup on Crystal
Install Amber CLI 2.0.2 or newer:

```bash
brew tap amberframework/amber_cli
brew install amber_cli
brew install amberframework/amber_cli/amber_cli
amber new my_app --type web
cd my_app
crystal spec
Expand Down
6 changes: 4 additions & 2 deletions docs/beta-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,13 @@ git --version
The tap name contains an underscore:

```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. The installed executables are `amber` and `amber-lsp`.

The expected CLI version is `2.0.2` or newer. If another executable is found,
run `command -v amber` and use the troubleshooting section below.

Expand Down
3 changes: 1 addition & 2 deletions docs/migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ amber routes
**After (V2 beta):**

```bash
brew tap amberframework/amber_cli
brew install amber_cli
brew install amberframework/amber_cli/amber_cli
amber new my_app --type web
cd my_app
shards install
Expand Down
5 changes: 2 additions & 3 deletions scripts/check_beta_contract.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ test "$shard_version" = "2.0.0-beta.2"
test "$source_version" = "$shard_version"

files=(README.md docs/README.md docs/getting-started.md docs/beta-installation.md docs/migration-guide.md RELEASE_NOTES_V2_BETA2.md)
grep -F 'brew tap amberframework/amber_cli' docs/beta-installation.md
grep -F 'brew install amber_cli' docs/beta-installation.md
grep -F 'brew install amberframework/amber_cli/amber_cli' docs/beta-installation.md
grep -F 'version: 2.0.0-beta.2' docs/getting-started.md
if grep -R -F 'Process.fork' src; then
echo "Amber V2 must compile with Crystal's default multithreaded runtime" >&2
Expand All @@ -19,7 +18,7 @@ fi
# runtime condition keeps the call reachable to the compiler.
crystal eval 'require "./src/amber"; Amber::Server.start if ENV["AMBER_COMPILE_SERVER"]?'

if grep -Ein 'crimson-knight/(amber|grant|gemma)|amberframework/amber-cli|brew install amber-cli|branch: v2-dev' "${files[@]}"; then
if grep -Ein 'crimson-knight/(amber|grant|gemma)|amberframework/amber-cli|brew tap amberframework/amber_cli|brew install amber-cli|brew install amber_cli|branch: v2-dev' "${files[@]}"; then
echo "Amber beta docs contain a stale install or dependency instruction" >&2
exit 1
fi
Expand Down
Loading