Skip to content

docs: say which formats --fields actually narrows #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tamnd merged 1 commit into from
Jul 25, 2026
Merged

docs: say which formats --fields actually narrows #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/content/reference/output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,15 @@ A non-empty `extra` is a bug report: it means the site added something and this
github tags golang/go --fields name,sha
```

`--fields` works on every format, and it can call back a field the table hides, since a hidden field keeps its name.
`--fields` works on the column formats: `table`, `csv`, `tsv`, `markdown`, and `list`.
It can call back a field the table hides, since a hidden field keeps its name.

It does not touch `json`, `jsonl`, or `raw`, which always carry the whole record.
Narrow those with `jq`:

```bash
github tags golang/go -n 3 | jq '{name, sha}'
```

`--no-header` drops the header row from `table`, `csv`, and `tsv`, which is what a downstream tool usually wants.

Expand Down
Loading