Skip to content

Add "doas" to make install, improve README #87

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
merged 2 commits into from
Nov 13, 2025
Merged

Add "doas" to make install, improve README #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a32ec8
Add doas support
tstromberg Nov 13, 2025
9306e1d
Update README
tstromberg Nov 13, 2025
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
9 changes: 8 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,14 @@ install-darwin: app-bundle
install-unix: build
@echo "Installing on $(shell uname)..."
@echo "Installing binary to /usr/local/bin..."
@sudo install -m 755 out/$(APP_NAME) /usr/local/bin/
@if command -v sudo >/dev/null 2>&1; then \
sudo install -m 755 out/$(APP_NAME) /usr/local/bin/; \
elif command -v doas >/dev/null 2>&1; then \
doas install -m 755 out/$(APP_NAME) /usr/local/bin/; \
else \
echo "Error: Neither sudo nor doas found. Please install the binary manually."; \
exit 1; \
fi
@echo "Installation complete! $(APP_NAME) has been installed to /usr/local/bin"

# Install on Windows
Expand Down
32 changes: 13 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,6 @@ The only PR tracker that honks at you when you're the bottleneck. Now shipping w
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.

![Review Goose Screenshot](media/screenshot.png)

## What It Does

- **Honks** when you're blocking someone's PR (authentic goose noises included)
- **Jet sounds** when your own PR is ready for the next stage
- **Smart turn-based assignment** - knows who is blocking a PR, knows when tests are failing, etc.
- **Auto-start** on login (macOS)
- **Auto-open** incoming PRs in your browser (off by default, rate-limited)
- **Org Filtering** for orgs you may not care about in a home or work context
- **Multi-platform** support for Linux, macOS, Windows, FreeBSD, whatever.

You can also visit the web-based dashboard at <https://dash.ready-to-review.dev/>

## Dependencies

- [go](https://go.dev/) 1.23.4 or higher
- [gh](https://cli.github.com/), AKA the GitHub command-line utility

## macOS Quick Start ⚡ (Get Honked At)

Install dependencies:
Expand All @@ -53,7 +35,19 @@ cd goose && make run

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.

### Using a fine-grained access token
## Linux/BSD/Windows Quick Start

1. Install the GitHub CLI and Go via your platforms recommended methods
2. Compile and install Goose:

```bash
go install github.com/codeGROOVE-dev/goose/cmd/goose@latest
```

3. Copy goose from $HOME/go/bin to wherever you prefer
4. Add goose to your auto-login so you never foget about PRs again

## Using a fine-grained access token

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:

Expand Down