Skip to content

Commit 61d6ff8

Browse files
grokifyclaude
andcommitted
docs(cli): update search-prs documentation for stdout default
Update CLI guide to reflect new search-prs behavior: - Default output is ASCII table to stdout - Document supported file formats (.xlsx, .md, .csv) - Add examples for piping and different output formats Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 4693787 commit 61d6ff8

1 file changed

Lines changed: 24 additions & 5 deletions

File tree

docs/guides/cli.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -276,21 +276,40 @@ Search for open pull requests by user.
276276
gogithub search-prs --accounts <users> [flags]
277277
```
278278

279+
By default, results are displayed as an ASCII table to stdout. Use `-o/--outfile` to write to a file, with format auto-detected from the extension.
280+
279281
#### Flags
280282

281283
| Flag | Short | Description | Default |
282284
|------|-------|-------------|---------|
283285
| `--accounts` | `-a` | GitHub accounts to search (comma-separated) | (required) |
284-
| `--outfile` | `-o` | Output Excel file | `githubissues.xlsx` |
286+
| `--outfile` | `-o` | Output file (format from extension) | stdout |
287+
288+
#### Supported Formats
289+
290+
| Extension | Format |
291+
|-----------|--------|
292+
| `.xlsx` | Excel spreadsheet |
293+
| `.md` | Markdown table |
294+
| `.csv` | CSV file |
285295

286296
#### Examples
287297

288298
```bash
289-
# Search for PRs by multiple users
290-
gogithub search-prs --accounts grokify,octocat --outfile prs.xlsx
291-
292-
# Single user
299+
# ASCII table to stdout (default)
293300
gogithub search-prs -a grokify
301+
302+
# Pipe to other tools
303+
gogithub search-prs -a grokify | grep someterm
304+
305+
# Search multiple users, save to Excel
306+
gogithub search-prs --accounts grokify,octocat -o prs.xlsx
307+
308+
# Save as Markdown
309+
gogithub search-prs -a grokify -o prs.md
310+
311+
# Save as CSV
312+
gogithub search-prs -a grokify -o prs.csv
294313
```
295314

296315
## Progress Display

0 commit comments

Comments
 (0)