Skip to content

Commit 0d7bc74

Browse files
committed
Rewrite README with full pitch + ASCII art
1 parent fa6e2a3 commit 0d7bc74

1 file changed

Lines changed: 54 additions & 8 deletions

File tree

README.md

Lines changed: 54 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1+
```
2+
_ _
3+
___| |__ _ __ __| |
4+
/ _ \ '_ \| '__/ _` | the aboard agent cli
5+
| __/ |_) | | | (_| | via homebrew
6+
\___|_.__/|_| \__,_|
7+
```
8+
19
# homebrew-aboard
210

3-
Homebrew tap for [`abrd`](https://github.com/Teamtailor/aboard-cli) — the Aboard agent CLI.
11+
Homebrew tap for **`abrd`** — the [Aboard](https://aboardhr.com) agent CLI.
12+
13+
Give AI assistants (Claude, Cursor, ChatGPT, …) read/write access to your Aboard HR data, on your behalf, from your terminal.
414

515
## Install
616

@@ -9,17 +19,53 @@ brew tap Teamtailor/aboard
919
brew install abrd
1020
```
1121

12-
`brew upgrade abrd` to pick up new versions.
22+
Then authenticate:
1323

14-
## Platforms
24+
```sh
25+
abrd auth login
26+
```
27+
28+
That opens `app.aboardhr.com/settings/cli-tokens/authorize` in your browser. Approve, and the CLI catches the token on a loopback callback.
29+
30+
To update later:
1531

16-
- macOS (Apple Silicon)
17-
- Linux (x86_64)
32+
```sh
33+
brew upgrade abrd
34+
```
1835

19-
Windows users: download the `.exe` directly from a [release](https://github.com/Teamtailor/homebrew-aboard/releases).
36+
## What `abrd` does
37+
38+
A single static binary — no Node, no Python, no build tools — that:
39+
40+
- Talks to `api.aboardhr.com` with a personal access token scoped to *your* account
41+
- Surfaces 1-on-1s, direct reports, agenda templates, skills, performance reviews, time off, and holidays as structured JSON
42+
- Plays nicely with agent skills so a coding assistant can use `abrd …` to look up *"who's on PTO next week"*, *"draft an agenda for my next 1:1 with X"*, *"summarise my team's last review cycle"* — and always stops to confirm before writes
43+
44+
Pair it with the [aboard agent skill](https://github.com/Teamtailor/aboard-skills) for the fastest setup — a single prompt that installs CLI, auth, and skill.
45+
46+
## Platforms
47+
48+
| OS | Architecture | Install |
49+
| -------------------- | ------------ | ---------------------- |
50+
| macOS | Apple silicon | `brew install abrd` |
51+
| Linux | x86_64 | `brew install abrd` |
52+
| Windows | x86_64 | grab the `.exe` from [Releases](https://github.com/Teamtailor/homebrew-aboard/releases) |
2053

2154
## How this tap is maintained
2255

23-
`Formula/abrd.rb` and the release tarballs are both regenerated automatically by the [release workflow](https://github.com/Teamtailor/aboard-cli/blob/main/.github/workflows/release.yml) in `Teamtailor/aboard-cli` whenever a `v*` tag is pushed there. Do not hand-edit the formula — your changes will be overwritten on the next release.
56+
```
57+
aboard-cli (tag v*)
58+
59+
60+
.github/workflows/release.yml
61+
62+
├──► builds tarballs (linux-amd64, darwin-arm64, windows-amd64)
63+
├──► publishes them to homebrew-aboard/releases
64+
└──► regenerates Formula/abrd.rb pointing at the new release
65+
```
66+
67+
`Formula/abrd.rb` and the release tarballs are both regenerated automatically. **Do not hand-edit the formula** — your changes will be overwritten on the next release.
68+
69+
## Issues & feedback
2470

25-
Source code, issues, and contributions: <https://github.com/Teamtailor/aboard-cli>.
71+
Open an issue on this repo. For anything Aboard-product-related, ping us in the usual channels.

0 commit comments

Comments
 (0)