mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 10:00:32 +00:00
feat: generate the gt command reference from gitea/cli
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
This commit is contained in:
261 files changed
+15116
-2
No files matched your search
@@ -0,0 +1,65 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "JSON output with --json and --jq"
|
||||
---
|
||||
|
||||
# gt help formatting
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
JSON output with --json and --jq
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
gt prints text for people by default. Scripts should use JSON: the columns and
|
||||
wording of text output may change between releases.
|
||||
|
||||
--json print every field
|
||||
--json FIELDS print only the comma-separated FIELDS, such as --json number,title
|
||||
-q, --jq EXPR filter the JSON with a jq expression; implies --json
|
||||
|
||||
The JSON FIELDS section of a command's help lists its fields, and shell completion
|
||||
offers them after --json. An unknown field reports the available ones.
|
||||
|
||||
--jq runs inside gt, so jq does not need to be installed. String results print
|
||||
without quotes:
|
||||
|
||||
$ gt issue list --json number,title --jq '.[] | "\(.number)\t\(.title)"'
|
||||
|
||||
Some fields cost extra requests, such as the reviewers of pr list, the blocked_by and blocks
|
||||
of issue view and issue edit, and the visibility of org member list. gt makes them only when
|
||||
the output includes the field: --json names it, or --json selects every field and the --jq
|
||||
expression names it. An expression that reaches such a field without naming it, as
|
||||
to_entries does, sees it empty; name the field in --json instead.
|
||||
|
||||
On a terminal, JSON is indented and colored; otherwise each value prints on one line.
|
||||
Commands that return no resource, such as deletes, reject --json.
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for formatting
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt](): Work with Gitea from your terminal
|
||||
Reference in new issue
Block a user