mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-08 11:00:34 +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,49 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Delete release assets"
|
||||
---
|
||||
|
||||
# gt release asset delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete release assets
|
||||
|
||||
```
|
||||
gt release asset delete <tag> <asset>... [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt release asset delete v1.0.0 gt-linux
|
||||
$ gt release asset delete v1.0.0 12 13 --yes
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--by-name Match assets by name only, also when numeric
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
## 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 release asset](../../release/asset/index.md): Manage release assets
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Download release assets"
|
||||
---
|
||||
|
||||
# gt release asset download
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Download release assets
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Download the assets of a release (default: the latest) by name or ID, those matching --pattern,
|
||||
or all of them; --archive downloads the source code instead. Existing files are replaced only with
|
||||
--clobber, and --output - writes one asset to standard output.
|
||||
```
|
||||
|
||||
```
|
||||
gt release asset download [<tag>] [<asset>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Download every asset of the latest release
|
||||
$ gt release download
|
||||
|
||||
# Download the Linux builds of a release into dist/
|
||||
$ gt release download v1.0.0 --pattern '*linux*' --dir dist
|
||||
|
||||
# Download the source code as a zip file
|
||||
$ gt release download v1.0.0 --archive zip
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-A, --archive string Download the source code archive {zip|tar.gz}
|
||||
--clobber Replace an existing file
|
||||
-D, --dir string Directory to download into
|
||||
-h, --help help for download
|
||||
-O, --output string File or directory to write to, or - for standard output (default: the download's name)
|
||||
-p, --pattern strings Download the assets whose names match this glob (repeatable)
|
||||
--skip-existing Keep an existing file and skip the download
|
||||
```
|
||||
|
||||
## 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 release asset](../../release/asset/index.md): Manage release assets
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Rename a release asset"
|
||||
---
|
||||
|
||||
# gt release asset edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Rename a release asset
|
||||
|
||||
```
|
||||
gt release asset edit <tag> <asset> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt release asset edit v1.0.0 gt-linux --name gt-linux-amd64
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for edit
|
||||
--name string New asset name
|
||||
```
|
||||
|
||||
## 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 release asset](../../release/asset/index.md): Manage release assets
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Manage release assets"
|
||||
---
|
||||
|
||||
# gt release asset
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Manage release assets
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List, upload, download, rename and delete the files attached to a release. Assets are addressed by their exact, case-sensitive name or by ID.
|
||||
```
|
||||
|
||||
```
|
||||
gt release asset [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for asset
|
||||
```
|
||||
|
||||
## 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 release](../../release/index.md): Manage releases
|
||||
* [gt release asset delete](../../release/asset/delete.md): Delete release assets
|
||||
* [gt release asset download](../../release/asset/download.md): Download release assets
|
||||
* [gt release asset edit](../../release/asset/edit.md): Rename a release asset
|
||||
* [gt release asset list](../../release/asset/list.md): List release assets
|
||||
* [gt release asset upload](../../release/asset/upload.md): Upload release assets
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "List release assets"
|
||||
---
|
||||
|
||||
# gt release asset list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List release assets
|
||||
|
||||
```
|
||||
gt release asset list <tag> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt release asset list v1.0.0
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
```
|
||||
|
||||
## 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 release asset](../../release/asset/index.md): Manage release assets
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Upload release assets"
|
||||
---
|
||||
|
||||
# gt release asset upload
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Upload release assets
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Upload files as assets of a release, named after the files unless --name renames a single file.
|
||||
An asset with the same name is replaced only with --clobber.
|
||||
```
|
||||
|
||||
```
|
||||
gt release asset upload <tag> <file>... [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt release upload v1.0.0 dist/gt-linux dist/gt-darwin
|
||||
$ gt release upload v1.0.0 dist/gt-linux --clobber
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--clobber Replace assets with the same name
|
||||
-h, --help help for upload
|
||||
--name string Asset name (default: the file's name)
|
||||
```
|
||||
|
||||
## 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 release asset](../../release/asset/index.md): Manage release assets
|
||||
Reference in new issue
Block a user