mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 18:10:36 +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,51 @@
|
||||
---
|
||||
sidebar_position: 19
|
||||
description: "Search within one selected Gitea instance"
|
||||
---
|
||||
|
||||
# gt search
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Search within one selected Gitea instance
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Search the repositories, issues and pull requests of the selected Gitea instance that your
|
||||
account can see.
|
||||
```
|
||||
|
||||
```
|
||||
gt search [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for search
|
||||
```
|
||||
|
||||
## 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](../index.md): Work with Gitea from your terminal
|
||||
* [gt search issue](../search/issue.md): Search issues
|
||||
* [gt search pr](../search/pr.md): Search pull requests
|
||||
* [gt search repo](../search/repo.md): Search repositories
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Search issues"
|
||||
---
|
||||
|
||||
# gt search issue
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Search issues
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Search the issues of every repository you can access on the instance, or of one
|
||||
repository with --repo. Words of the query match titles and bodies.
|
||||
```
|
||||
|
||||
```
|
||||
gt search issue [<query>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt search issue "login error"
|
||||
# Search one repository; its labels and milestones are checked
|
||||
$ gt search issue crash -R alice/project --label bug --milestone v1.0
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--assigned Assigned to you
|
||||
-A, --author string Filter by author; @me for yourself
|
||||
--authored Created by you
|
||||
-h, --help help for issue
|
||||
-l, --label names Filter by label names
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--mentioned Mentioning you
|
||||
-m, --milestone titles Filter by milestone titles, comma-separated
|
||||
--owner owner Search only the repositories of this owner
|
||||
--page int Result page (default 1)
|
||||
--since string Updated since a date, timestamp, or duration ago
|
||||
-s, --state string Filter by state {open|closed|all} (default "open")
|
||||
--team team Search only the repositories of this organization team (requires --owner)
|
||||
--until string Updated before a date, timestamp, or duration ago
|
||||
```
|
||||
|
||||
## 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 search](../search/index.md): Search within one selected Gitea instance
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Search pull requests"
|
||||
---
|
||||
|
||||
# gt search pr
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Search pull requests
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Search the pull requests of every repository you can access on the instance, or of one
|
||||
repository with --repo. Words of the query match titles and bodies.
|
||||
```
|
||||
|
||||
```
|
||||
gt search pr [<query>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt search pr "login error"
|
||||
# Search one repository; its labels and milestones are checked
|
||||
$ gt search pr crash -R alice/project --label bug --milestone v1.0
|
||||
$ gt search pr --review-requested
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--assigned Assigned to you
|
||||
-A, --author string Filter by author; @me for yourself
|
||||
--authored Created by you
|
||||
-h, --help help for pr
|
||||
-l, --label names Filter by label names
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--mentioned Mentioning you
|
||||
-m, --milestone titles Filter by milestone titles, comma-separated
|
||||
--owner owner Search only the repositories of this owner
|
||||
--page int Result page (default 1)
|
||||
--review-requested Requesting your review (instance-wide search)
|
||||
--reviewed Reviewed by you (instance-wide search)
|
||||
--since string Updated since a date, timestamp, or duration ago
|
||||
-s, --state string Filter by state {open|closed|all} (default "open")
|
||||
--team team Search only the repositories of this organization team (requires --owner)
|
||||
--until string Updated before a date, timestamp, or duration ago
|
||||
```
|
||||
|
||||
## 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 search](../search/index.md): Search within one selected Gitea instance
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Search repositories"
|
||||
---
|
||||
|
||||
# gt search repo
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Search repositories
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Search the names and descriptions of repositories, or their topics with --topic.
|
||||
```
|
||||
|
||||
```
|
||||
gt search repo [<query>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Search repositories about a CLI
|
||||
$ gt search repo command line
|
||||
|
||||
# Search the archived repositories of an organization
|
||||
$ gt search repo --owner acme --archived
|
||||
|
||||
# Search by topic, most recently updated first
|
||||
$ gt search repo go --topic --sort updated --order desc
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--archived Only archived repositories (use =false for active)
|
||||
-h, --help help for repo
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--order string Sort order (requires --sort) {asc|desc} (default "asc")
|
||||
--owner string Only repositories of this user or organization
|
||||
--page int Result page (default 1)
|
||||
--private Only private repositories (use =false for public)
|
||||
--sort string Sort by (default: alphabetical, your own repositories first) {alpha|created|updated|size|id}
|
||||
--topic Match repository topics
|
||||
--type string Only repositories of this kind {fork|source|mirror}
|
||||
```
|
||||
|
||||
## 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 search](../search/index.md): Search within one selected Gitea instance
|
||||
Reference in new issue
Block a user