Skip to content

Commit ad7ee9b

Browse files
BjoernSchotteclaude
andcommitted
docs: add Homebrew installation instructions
- README.md: Add Homebrew as primary install method - getting-started.md: Add Homebrew, manual download, and from-source sections Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 06576b1 commit ad7ee9b

2 files changed

Lines changed: 47 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ A blazingly fast CLI for Atlassian products. Sync Confluence pages as markdown,
3838

3939
## Installation
4040

41+
### Homebrew (macOS & Linux)
42+
43+
```bash
44+
brew install bjoernschotte/tap/atlcli
45+
```
46+
47+
### From Source
48+
4149
```bash
4250
git clone https://github.com/BjoernSchotte/atlcli.git
4351
cd atlcli

docs/getting-started.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,47 @@ This guide walks you through installing atlcli, authenticating with Atlassian, a
44

55
## Installation
66

7-
### Prerequisites
7+
### Homebrew (Recommended)
88

9-
- [Bun](https://bun.sh) v1.0 or later
10-
- An Atlassian Cloud account
9+
The easiest way to install atlcli on macOS or Linux:
10+
11+
```bash
12+
brew install bjoernschotte/tap/atlcli
13+
```
14+
15+
This installs the latest release and adds `atlcli` to your PATH automatically.
16+
17+
To upgrade to a newer version:
18+
19+
```bash
20+
brew upgrade atlcli
21+
```
22+
23+
### Manual Download
1124

12-
### Install from Source
25+
Download the latest release for your platform from the [releases page](https://github.com/BjoernSchotte/atlcli/releases):
26+
27+
| Platform | File |
28+
|----------|------|
29+
| macOS (Apple Silicon) | `atlcli-darwin-arm64.tar.gz` |
30+
| macOS (Intel) | `atlcli-darwin-x64.tar.gz` |
31+
| Linux (ARM64) | `atlcli-linux-arm64.tar.gz` |
32+
| Linux (x64) | `atlcli-linux-x64.tar.gz` |
33+
34+
Extract and add to your PATH:
35+
36+
```bash
37+
tar -xzf atlcli-*.tar.gz
38+
sudo mv atlcli /usr/local/bin/
39+
```
40+
41+
### From Source
42+
43+
For development or if you want the latest unreleased changes:
44+
45+
**Prerequisites:**
46+
47+
- [Bun](https://bun.sh) v1.0 or later
1348

1449
```bash
1550
git clone https://github.com/BjoernSchotte/atlcli.git

0 commit comments

Comments
 (0)