Skip to content

docs: add Homebrew tap to installation page, replace COMING SOON #2

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

Open
vinceblock99 wants to merge 2 commits into
base: release
Choose a base branch
from
Open

docs: add Homebrew tap to installation page, replace COMING SOON #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cdaaa8
docs: add Homebrew tap to installation page, replace COMING SOON
vinceblock99 May 16, 2026
4062f1f
docs: clarify Homebrew-on-Linux is supported; explicit anchor id
vinceblock99 May 16, 2026
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
40 changes: 35 additions & 5 deletions docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,31 @@ title: Installation

# Installing Atomic

This guide will help you install Atomic VCS on your system. The recommended installation path is the hosted installer script from Atomic Storage. Development builds can still be installed from source.
This guide will help you install Atomic VCS on your system. Homebrew users (macOS or Linux) should prefer the official tap; Linux, CI, Windows, and other non-Homebrew users should use the hosted installer or manual release downloads. Development builds can still be installed from source.

## Installation Methods

### Hosted Installer (Recommended)
### macOS — Homebrew (Recommended) {#homebrew}

Install the latest Atomic CLI release with the installer hosted by Atomic Storage:
The official Homebrew tap is the easiest path on macOS:

```bash
brew install atomicdotdev/tap/atomic
```

Upgrade later with:

```bash
brew upgrade atomicdotdev/tap/atomic
```

After installation, `brew upgrade atomic` also works in normal Homebrew setups.

The tap supports both Apple Silicon and Intel Macs, and Linux x86_64 / aarch64 for users who prefer Homebrew on Linux.

### Hosted Installer (Linux, CI, no Homebrew)

For Linux, CI environments, or any machine without Homebrew, install the latest Atomic CLI release with the hosted installer:

```bash
curl -sSf https://atomic.storage/install.sh | sh
Expand All @@ -20,7 +38,7 @@ curl -sSf https://atomic.storage/install.sh | sh
Install a specific version:

```bash
curl -sSf https://atomic.storage/install.sh | ATOMIC_VERSION=0.5.1 sh
curl -sSf https://atomic.storage/install.sh | ATOMIC_VERSION=0.6.0 sh
```

Install to a user-writable directory:
Expand Down Expand Up @@ -142,7 +160,19 @@ source ~/.bashrc # or source ~/.zshrc

## Distribution Packages

**COMING SOON**
### Homebrew

Available via the official tap at [atomicdotdev/homebrew-tap](https://github.com/atomicdotdev/homebrew-tap):

```bash
brew install atomicdotdev/tap/atomic
```

Covers macOS (Apple Silicon and Intel) and Linux (x86_64 and aarch64). See the [Homebrew section](#homebrew) above for full usage.

### Other package managers

Distribution packages for `apt`, `dnf`, `pacman`, Scoop, and winget are tracked in the [roadmap](https://github.com/atomicdotdev/atomic/blob/release/docs/ROADMAP.md). Until they ship, use the hosted installer on Linux and download the `.zip` directly from the [release page](https://github.com/atomicdotdev/atomic/releases/latest) on Windows.

## Building from Git (Development)

Expand Down