CLI Documentation

Auto Release CLI

Generate release notes automatically with AI-powered templates.

macOS (amd64, arm64) Linux (amd64, arm64) Windows (amd64)

Installation Methods

macOS (Homebrew)

Run in Terminal
brew tap papyrus-digital/auto-release-cli-distribution https://github.com/papyrus-digital/auto-release-cli-distribution
brew install arn

Windows (Scoop)

1. Install Scoop

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser; irm get.scoop.sh | iex

2. Install Git

scoop install git

3. Install arn

scoop bucket add arn https://github.com/papyrus-digital/auto-release-cli-distribution
scoop install arn

Windows (Direct Download)

  1. Download the latest release from GitHub Releases
  2. Extract the ZIP file
  3. If Windows SmartScreen shows a warning:
    • Click "More info"
    • Click "Run anyway"
    • Or: Right-click the .exe → Properties → Unblock
  4. Add the extracted directory to your PATH

Linux (Direct Download)

  1. Download the latest release from GitHub Releases
  2. Extract the ZIP file
    3. # Extract and install
sudo tar -C /usr/local/bin -xzf arn_{CURRENT_VERSION}_linux_amd64.tar.gz arn

Upgrade

macOS (Homebrew)

Run in Terminal
brew upgrade arn

Windows (Scoop)

Run in PowerShell
scoop update
scoop update arn

Manual Upgrade

For direct downloads (Linux/Windows), simply download and install the latest version over the existing one following the installation instructions above.

Quick Start

1. Initialize the CLI

arn init

2. Generate Release Notes

arn generate

Troubleshooting

Authentication Failed

If you're getting authentication errors, verify your API key is correct and hasn't been revoked. Check your API key status in the dashboard settings.

If macOS shows a Gatekeeper warning when running the binary:

xattr -d com.apple.quarantine /usr/local/bin/arn
  • Go to System Preferences > Security & Privacy
  • Click "Open Anyway" if prompted
  • Or right-click the binary and select "Open"

Windows SmartScreen Warning

Important: You can distribute Windows binaries without a code signing certificate. The binaries are signed with GPG.

If Windows shows a SmartScreen warning:

  1. Click "More info" on the warning dialog
  2. Click "Run anyway"
  3. Or: Right-click the .exe file → Properties → Unblock → OK

Permission Denied

If you get a "permission denied" error:

chmod +x /usr/local/bin/arn

Command Not Found

Verify the binary is in your PATH:

which arn # Linux/macOS where arn # Windows