Configuration

Docs version: v0.1.11 • GitHub Releases • CHANGELOG.md

Configure RugbyClaw with API key and preferences

Two Modes

Proxy Mode (Default)

Works immediately after install with no configuration. Uses a shared proxy with 50 requests per day — perfect for casual fans.

Direct Mode (Unlimited)

Add your own free API key for unlimited requests:

rugbyclaw config

Configuration Wizard

Run the interactive setup:

rugbyclaw config

The wizard will guide you through:

  1. API key setup (or skip to use proxy mode)
  2. Favorite leagues selection (from currently supported leagues)
  3. Timezone selection
  4. Favorite team (optional)

Get a Free API Key

  1. Go to api-sports.io
  2. Sign up for a free account
  3. Navigate to My Account → API Key
  4. Copy your API key
  5. Run rugbyclaw config and paste it

Free tier includes:

  • 100 requests per day
  • All currently supported RugbyClaw leagues (8 total)
  • No credit card required

Some leagues on the website are marked Coming Soon and are not selectable yet in CLI commands.

Config File Location

~/.config/rugbyclaw/config.json

Example Config

{
  "apiKey": "your-api-key-here",
  "leagues": ["top14", "premiership", "urc", "champions_cup", "six_nations"],
  "timezone": "America/New_York",
  "favoriteTeam": "Stade Toulousain"
}

Reset Configuration

To start fresh:

rm ~/.config/rugbyclaw/config.json
rugbyclaw config

Environment Variables

You can also set the API key via environment variable:

export RUGBY_API_KEY="your-api-key-here"

Add to ~/.bashrc or ~/.zshrc to make permanent.

Related