github-rate-limit

# Check GitHub API Rate Limit

Check your current GitHub API rate limit status and remaining requests.

## Usage

```bash
npx tsx scripts/rate-limit.ts [options]
```

### Options

| Option | Description |
|--------|-------------|
| `--token=TOKEN` | GitHub Personal Access Token (optional, overrides GITHUB_TOKEN env var) |
| `--no-cache` | Bypass cache and fetch fresh data from API |

### Output

```
GitHub API Rate Limit Status
-----------------------------

Core API:
  Limit: 5,000 requests/hour
  Used: 1,234 requests
  Remaining: 3,766 requests
  Resets in: 23 minutes

Search API:
  Limit: 30 requests/minute
  Used: 5 requests
  Remaining: 25 requests
  Resets in: 45 seconds

Authentication: Authenticated (your_token_here)
```

## Script Execution (Preferred)

```bash
npx tsx scripts/rate-limit.ts [options]
```

Options:
- `--token=TOKEN` - GitHub Personal Access Token (optional, overrides GITHUB_TOKEN env var)
- `--no-cache` - Bypass cache and fetch fresh data from API

Run from the github-api plugin directory: `~/.claude/plugins/cache/github-api/`

## Rate Limit API

```
GET https://api.github.com/rate_limit
```

## Response Format

The response contains rate limit information for different API categories:

```json
{
  "resources": {
    "core": {
      "limit": 5000,
      "used": 1234,
      "remaining": 3766,
      "reset": 1697376000
    },
    "search": {
      "limit": 30,
      "used": 5,
      "remaining": 25,
      "reset": 1697372400
    }
  },
  "rate": {
    "limit": 5000,
    "used": 1234,
    "remaining": 3766,
    "reset": 1697376000
  }
}
```

## Rate Limit Categories

### Core API
- **Endpoints**: Most GitHub REST API endpoints
- **Unauthenticated**: 60 requests/hour
- **Authenticated**: 5,000 requests/hour
- **Reset**: Hourly

### Search API
- **Endpoints**: Search endpoints (e.g., code search, repo search)
- **Unauthenticated**: 10 requests/minute
- **Authenticated**: 30 requests/minute
- **Reset**: Every minute

## Rate Limits by Authenticati