Getting Started
Table of Contents
Installation #
Download Issuenator from the Mac App Store.
Requirements #
- macOS 14.0 (Sonoma) or later
- A GitHub account
- A GitHub personal access token
Setting Up Your API Key #
Issuenator uses the GitHub GraphQL API to fetch issues from your repositories. You’ll need to create a personal access token:
Creating a Fine-Grained Token (Recommended) #
- Go to GitHub Settings > Developer settings > Personal access tokens > Fine-grained tokens
- Click “Generate new token”
- Give it a descriptive name like “Issuenator”
- Set an expiration
- Under “Repository access”, choose which repos to grant access
- Under “Permissions > Repository permissions”, enable:
- Issues: Read-only
- Metadata: Read-only
- Pull requests: Read-only (for linked PR information)
- Under “Permissions > Account permissions”, enable:
- Profile: Read and write (for your username and avatar). We only need read permission, but GitHub doesn’t expose read-only for Profile.
- Click “Generate token” and copy it
Creating a Classic Token #
- Go to GitHub Settings > Developer settings > Personal access tokens > Tokens (classic)
- Click “Generate new token (classic)”
- Give it a descriptive name
- Set an expiration
- Select scopes:
repouser
- Click “Generate token” and copy it
Adding the Token to Issuenator #
- Open Issuenator
- You’ll be prompted to enter your API key on first launch
- Paste your token and click Save
- The token is stored securely in your macOS Keychain
Adding Your First Repository #
Once your API key is configured:
- Enter the full GitHub URL (e.g.,
https://github.com/apple/swift) - Choose a color for the repository label
- Optionally customize fetch frequency and archive settings
- Click Add Repository
Issuenator will fetch all open issues from the repository. Depending on the repository size, this may take a moment.
Adding More Repositories #
After initial setup, use Cmd+Ctrl+A or Repositories → Add Repository to add more repos.
Add One at a Time #
- On the Add One tab, enter the full GitHub URL (e.g.,
https://github.com/apple/swift) - Optionally set a custom display name
- Choose a color for the repository
- Click Add Repository
Add Multiple Repositories #
Need to add several repos at once? Use bulk import:
- Select the Add Many tab
- Enter full repository URLs, one per line:
https://github.com/apple/swift https://github.com/facebook/react https://github.com/microsoft/vscode - Click Add Repositories
Colors are automatically assigned to each repository. Issuenator will validate each URL and fetch all open issues.
Next Steps #
- Learn about the different Dashboards and how to use them
- Set up Filters & Tags to organize issues automatically
- Customize Settings to match your workflow