mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-04 17:19:52 +00:00
bircniandsilverwind
09bb4cabcf
Adds a CLI product for gt (https://gitea.com/gitea/cli), set up like the runner, with short guides for installation, logging in, CI and scripting. Each command's details stay in gt <command> --help. Until the first release, the docs are served at /cli/; make cut-version PRODUCT=cli VERSION=0.1 adds the release series. Closes https://gitea.com/gitea/cli/issues/16 <!-- cloudflare-preview --> Preview: https://pr-603.docs-gitea-com.pages.dev --------- Co-authored-by: silverwind <[email protected]> Reviewed-on: https://gitea.com/gitea/docs/pulls/603 Reviewed-by: Lunny Xiao <[email protected]> Reviewed-by: silverwind <[email protected]>
23 lines
744 B
Markdown
23 lines
744 B
Markdown
---
|
|
sidebar_position: 5
|
|
---
|
|
|
|
# Output and scripting
|
|
|
|
Scripts should read JSON: the text output is meant for people and may change.
|
|
|
|
```bash
|
|
gt pr view 123 --json number,title,state
|
|
gt issue list --json number,title --jq '.[] | "\(.number)\t\(.title)"'
|
|
```
|
|
|
|
`--json` prints all fields or the ones you list; the **JSON FIELDS** section of a command's
|
|
`--help` names them. `--jq` filters the result without needing jq installed. Piped lists
|
|
print as tab-separated values.
|
|
|
|
gt exits with 0 on success, 1 when a command fails, 2 on a usage error and 4 when
|
|
authentication is missing or rejected; `gt help exit-codes` lists all codes.
|
|
|
|
`gt api` calls any API endpoint with gt's login, and `gt alias set` defines shortcuts for
|
|
commands you use often.
|