You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-21Lines changed: 25 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,24 +12,6 @@ The only PR tracker that honks at you when you're the bottleneck. Now shipping w
12
12
Lives in your menubar like a tiny waterfowl of productivity shame, watching your GitHub PRs and making aggressive bird sounds when you're blocking someone's code from seeing the light of production.
13
13
14
14

15
-
16
-
## What It Does
17
-
18
-
-**Honks** when you're blocking someone's PR (authentic goose noises included)
19
-
-**Jet sounds** when your own PR is ready for the next stage
20
-
-**Smart turn-based assignment** - knows who is blocking a PR, knows when tests are failing, etc.
21
-
-**Auto-start** on login (macOS)
22
-
-**Auto-open** incoming PRs in your browser (off by default, rate-limited)
23
-
-**Org Filtering** for orgs you may not care about in a home or work context
24
-
***Multi-platform** support for Linux, macOS, Windows, FreeBSD, whatever.
25
-
26
-
You can also visit the web-based dashboard at https://dash.ready-to-review.dev/
27
-
28
-
## Dependencies
29
-
30
-
*[go](https://go.dev/) 1.23.4 or higher
31
-
*[gh](https://cli.github.com/), AKA the GitHub command-line utility
32
-
33
15
## macOS Quick Start ⚡ (Get Honked At)
34
16
35
17
Install dependencies:
@@ -53,7 +35,19 @@ cd goose && make run
53
35
54
36
This will will cause the goose to implant itself into `/Applications/Review Goose.app` for future invocations. To be persistently annoyed every time you login, click the `Start at Login` menu item.
55
37
56
-
### Using a fine-grained access token
38
+
## Linux/BSD/Windows Quick Start
39
+
40
+
1. Install the GitHub CLI and Go via your platforms recommended methods
41
+
2. Compile and install Goose:
42
+
43
+
```bash
44
+
go install github.com/codeGROOVE-dev/goose/cmd/goose@latest
45
+
```
46
+
47
+
3. Copy goose from $HOME/go/bin to wherever you prefer
48
+
4. Add goose to your auto-login so you never foget about PRs again
49
+
50
+
## Using a fine-grained access token
57
51
58
52
If you want more control over which repositories the goose can access, you can use a [fine-grained personal access token](https://github.com/settings/personal-access-tokens/new) with the following permissions:
We don't yet persist fine-grained tokens to disk - PR's welcome!
70
64
65
+
## Usage
66
+
67
+
-**macOS/Windows**: Click the tray icon to show the menu
68
+
-**Linux/BSD**: Right-click the tray icon to show the menu (left-click refreshes PRs)
69
+
71
70
## Known Issues
72
71
73
-
- Visual notifications won't work on macOS until we release signed binaries.
72
+
- Visual notifications won't work reliably on macOS until we release signed binaries.
73
+
- Tray icons on GNOME require [snixembed](https://git.sr.ht/~steef/snixembed) and enabling the [Legacy Tray extension](https://www.omgubuntu.co.uk/2024/08/gnome-official-status-icons-extension). Goose will automatically launch snixembed if needed, but you must install it first (e.g., `apt install snixembed` or `yay -S snixembed`).
74
74
75
75
## Pricing
76
76
77
-
- Free forever for public repositories ❤️
77
+
- Free forever for public open-source repositories ❤️
78
78
- Private repo access will soon be a supporter-only feature to ensure the goose is fed. ($1/mo)
79
79
80
80
## Privacy
@@ -85,6 +85,10 @@ We don't yet persist fine-grained tokens to disk - PR's welcome!
85
85
- No data is resold to anyone. We don't even want it.
86
86
- No telemetry is collected
87
87
88
+
## License
89
+
90
+
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
91
+
88
92
---
89
93
90
94
Built with 🪿 by [codeGROOVE](https://codegroove.dev/) - PRs welcome!
0 commit comments