github-readme

# Get GitHub Repository README

Fetch and decode the README content from a GitHub repository.

## Usage

```bash
npx tsx scripts/readme.ts <repository> [options]
```

### Arguments

| Argument | Required | Description |
|----------|----------|-------------|
| `repository` | Yes | Repository in format `owner/repo` or full GitHub URL |

### 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

```
README.md from facebook/react
-----------------------------
Size: 12.3 KB
URL: https://github.com/facebook/react/blob/main/README.md

# README Contents

[decoded README content displayed here]
```

## Script Execution (Preferred)

```bash
npx tsx scripts/readme.ts <repository> [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/`

## README API

```
GET https://api.github.com/repos/{owner}/{repo}/readme
```

### Parameters

| Parameter | Required | Description |
|-----------|----------|-------------|
| `owner` | Yes | Repository owner (user or organization) |
| `repo` | Yes | Repository name |

### Examples

Get README content:
```
https://api.github.com/repos/facebook/react/readme
```

## Response Format

The response contains README metadata and base64-encoded content:

- **`name`** - README filename (e.g., "README.md")
- **`path`** - Path to the README
- **`sha`** - Git SHA for the file
- **`size`** - File size in bytes
- **`url`** - API URL for the file
- **`html_url`** - GitHub URL to view the README
- **`content`** - Base64-encoded content
- **`encoding`** - Encoding type (always "base64")

## README Detection

GitHub automatically detects and prioritizes README files in this order:
1. `README.md`
2