Skip to content

Commit 7d00f8b

Browse files
rubenmarcusclaude
andcommitted
docs: add github.defaultIssuesRepo configuration
- Document the new defaultIssuesRepo config option in GitHub source docs - Add configuration section to GitHub source page - Update CLI config docs with the new key Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 0d2fd1e commit 7d00f8b

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

docs/docs/cli/config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ ralph-starter config set apiKey sk-ant-xxxx
5454
ralph-starter config set linear.apiKey lin_api_xxxx
5555
ralph-starter config set notion.token secret_xxxx
5656
ralph-starter config set github.token ghp_xxxx
57+
58+
# Set defaults
59+
ralph-starter config set github.defaultIssuesRepo owner/repo
5760
```
5861

5962
### Delete Value
@@ -70,6 +73,7 @@ ralph-starter config delete linear.apiKey
7073
| `linear.apiKey` | Linear API key |
7174
| `notion.token` | Notion integration token |
7275
| `github.token` | GitHub personal access token |
76+
| `github.defaultIssuesRepo` | Default repo for `--issue` without `--project` |
7377

7478
## Storage Location
7579

docs/docs/sources/github.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,10 @@ ralph-starter run --from github --project owner/repo --label "sprint-1" --status
5959
Fetch a specific issue by number:
6060

6161
```bash
62-
# By issue number
62+
# By issue number (uses default repo if configured)
63+
ralph-starter run --from github --issue 123
64+
65+
# From a specific repo
6366
ralph-starter run --from github --project owner/repo --issue 123
6467

6568
# By full URL
@@ -73,16 +76,37 @@ This fetches:
7376

7477
Perfect for building features from well-specified issues.
7578

79+
## Default Issues Repository
80+
81+
Configure a default repository for fetching issues, so you don't need to specify `--project` every time:
82+
83+
```bash
84+
# Set your default issues repo
85+
ralph-starter config set github.defaultIssuesRepo myorg/my-ideas
86+
87+
# Now you can simply run:
88+
ralph-starter run --from github --issue 42
89+
```
90+
91+
This is useful for teams that maintain a central ideas or roadmap repository.
92+
7693
## Options
7794

7895
| Option | Description | Default |
7996
|--------|-------------|---------|
80-
| `--project` | Repository in `owner/repo` format | Required |
97+
| `--project` | Repository in `owner/repo` format | Configured default or required |
8198
| `--label` | Filter by label name | None |
8299
| `--status` | Filter by status (`open`, `closed`, `all`) | `open` |
83100
| `--limit` | Maximum issues to fetch | 20 |
84101
| `--issue` | Specific issue number to fetch | None |
85102

103+
## Configuration
104+
105+
| Key | Description |
106+
|-----|-------------|
107+
| `github.token` | Personal access token (if not using gh CLI) |
108+
| `github.defaultIssuesRepo` | Default repository for `--issue` without `--project` |
109+
86110
## Issue Format
87111

88112
GitHub issues are converted to specs with:

0 commit comments

Comments
 (0)