nprasad2077/docs
1
1 Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-11-05 17:45:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: drop the generated gt reference

Browse Source 
The per-command reference made the pages long and repeated what
gt <command> --help shows. Keep the guides and remove the generator,
its workflow and the sidebar handling it needed.

Signed-off-by: bircni <[email protected]>
This commit is contained in:
bircni committed 2026-10-22 18:31:31 +02:00
1 parent 011651ad16
commit 540757fe56
264 files changed
+11 -15121
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

cli-docs/reference/admin/index.md
-48
View File
@@ -1,48 +0,0 @@
---
sidebar_position: 1
description: "Manage instance administration"
---
# gt admin
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage instance administration
## Synopsis
```text
Administer the Gitea instance. These commands need an administrator account.
```
```
gt admin [flags]
```
## Options
```
-h, --help help for admin
```
## 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 admin user](../admin/user/index.md): Manage registered accounts
cli-docs/reference/admin/user/create.md
-67
View File
@@ -1,67 +0,0 @@
---
sidebar_position: 1
description: "Create an account"
---
# gt admin user create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create an account
## Synopsis
```text
Create an account. On a terminal, gt asks for a missing username, email address and
password; the new account must change its password on its first sign-in unless
--must-change-password=false is passed.
```
```
gt admin user create [<username>] [flags]
```
## Examples
```
$ gt admin user create carol --email [email protected]
# read the password from a file instead of a prompt
$ gt admin user create ci-bot --email [email protected] --password-file pw.txt --must-change-password=false
```
## Options
```
--admin Administrator privileges (use =false to revoke)
--email string Email address
--full-name string Display name
-h, --help help for create
--must-change-password Require password change on next sign-in (use =false to disable) (default true)
--password string Password (prefer --password-file)
--password-file string Read password from file or - for stdin; remove one trailing line ending
--prohibit-login Prohibit signing in (use =false to revoke)
--restricted Restrict account access (use =false to revoke)
--username string Account username
--visibility string Profile visibility, by default the instance's default {public|limited|private}
```
## 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 admin user](../../admin/user/index.md): Manage registered accounts
cli-docs/reference/admin/user/delete.md
-57
View File
@@ -1,57 +0,0 @@
---
sidebar_position: 2
description: "Delete an account"
---
# gt admin user delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete an account
## Synopsis
```text
Delete an account. Gitea refuses while the user owns repositories or organizations, unless
--purge deletes the account with everything it owns.
```
```
gt admin user delete <username> [flags]
```
## Examples
```
$ gt admin user delete spammer
# also delete the user's repositories, packages and organization memberships (and organizations they solely own)
$ gt admin user delete spammer --purge
```
## Options
```
-h, --help help for delete
--purge Also delete the user's repositories, packages, organization memberships and the organizations they solely own
```
## 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 admin user](../../admin/user/index.md): Manage registered accounts
cli-docs/reference/admin/user/edit.md
-68
View File
@@ -1,68 +0,0 @@
---
sidebar_position: 3
description: "Edit an account"
---
# gt admin user edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit an account
```
gt admin user edit <username> [flags]
```
## Examples
```
$ gt admin user edit bob --full-name "Bob Builder" --restricted
# reset a password and require a new one on the next sign-in
$ gt admin user edit bob --password-file pw.txt --must-change-password
# revoke administrator privileges
$ gt admin user edit bob --admin=false
```
## Options
```
--active Activate account (use =false to revoke)
--admin Administrator privileges (use =false to revoke)
--allow-create-organization Allow creating organizations (use =false to revoke)
--allow-git-hook Allow Git hooks (use =false to revoke)
--allow-import-local Allow local repository imports (use =false to revoke)
--description string Profile description
--email string Email address
--full-name string Display name
-h, --help help for edit
--location string Location
--max-repo-creation int Repository creation limit (-1 uses the instance default)
--must-change-password Require password change on next sign-in (use =false to disable)
--password string Password (prefer --password-file)
--password-file string Read password from file or - for stdin; remove one trailing line ending
--prohibit-login Prohibit signing in (use =false to revoke)
--restricted Restrict account access (use =false to revoke)
--visibility string Profile visibility {public|limited|private}
--website string Website URL
```
## 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 admin user](../../admin/user/index.md): Manage registered accounts
cli-docs/reference/admin/user/index.md
-53
View File
@@ -1,53 +0,0 @@
---
sidebar_position: 1
description: "Manage registered accounts"
---
# gt admin user
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage registered accounts
## Synopsis
```text
List, view, create, edit and delete the accounts of the instance. These commands need an
administrator account.
```
```
gt admin user [flags]
```
## Options
```
-h, --help help for user
```
## 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 admin](../../admin/index.md): Manage instance administration
* [gt admin user create](../../admin/user/create.md): Create an account
* [gt admin user delete](../../admin/user/delete.md): Delete an account
* [gt admin user edit](../../admin/user/edit.md): Edit an account
* [gt admin user list](../../admin/user/list.md): List registered accounts
* [gt admin user view](../../admin/user/view.md): View an account
cli-docs/reference/admin/user/list.md
-54
View File
@@ -1,54 +0,0 @@
---
sidebar_position: 4
description: "List registered accounts"
---
# gt admin user list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List registered accounts
```
gt admin user list [flags]
```
## Examples
```
$ gt admin user list
# find accounts by username, name or email
$ gt admin user list --query bob
# print the email addresses
$ gt admin user list --jq '.[].email'
```
## Options
```
-h, --help help for list
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
--query string Only list accounts whose username, name or email contains this text
```
## 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 admin user](../../admin/user/index.md): Manage registered accounts
cli-docs/reference/admin/user/view.md
-48
View File
@@ -1,48 +0,0 @@
---
sidebar_position: 5
description: "View an account"
---
# gt admin user view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View an account
```
gt admin user view <username> [flags]
```
## Examples
```
$ gt admin user view bob
$ gt admin user view bob --json email,admin
```
## Options
```
-h, --help help for view
```
## 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 admin user](../../admin/user/index.md): Manage registered accounts
cli-docs/reference/alias/delete.md
-50
View File
@@ -1,50 +0,0 @@
---
sidebar_position: 1
description: "Delete shortcuts"
---
# gt alias delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete shortcuts
```
gt alias delete [<name>...] [flags]
```
## Examples
```
$ gt alias delete il
$ gt alias delete il review
$ gt alias delete --all
```
## Options
```
--all Delete every alias
-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 alias](../alias/index.md): Create shortcuts for gt commands
cli-docs/reference/alias/index.md
-56
View File
@@ -1,56 +0,0 @@
---
sidebar_position: 2
description: "Create shortcuts for gt commands"
---
# gt alias
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create shortcuts for gt commands
## Synopsis
```text
Create shortcuts for gt commands.
An alias expands to a gt command with its arguments before gt runs it: after
gt alias set il "issue list --label bug", gt il --state all runs
gt issue list --label bug --state all. $1, $2 and so on in the expansion take the
arguments in that position; other arguments follow the expansion. Aliases never run a
shell, and built-in commands always win over an alias of the same name.
```
```
gt alias [flags]
```
## Options
```
-h, --help help for alias
```
## 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 alias delete](../alias/delete.md): Delete shortcuts
* [gt alias list](../alias/list.md): List shortcuts
* [gt alias set](../alias/set.md): Create a shortcut for a gt command
cli-docs/reference/alias/list.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 2
description: "List shortcuts"
---
# gt alias list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List shortcuts
```
gt alias list [flags]
```
## Examples
```
$ gt alias list
# Print the expansion of one alias
$ gt alias list --jq .il
```
## Options
```
-h, --help help for list
```
## 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 alias](../alias/index.md): Create shortcuts for gt commands
cli-docs/reference/alias/set.md
-53
View File
@@ -1,53 +0,0 @@
---
sidebar_position: 3
description: "Create a shortcut for a gt command"
---
# gt alias set
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create a shortcut for a gt command
```
gt alias set <name> <expansion> [flags]
```
## Examples
```
# gt il runs gt issue list --label bug
$ gt alias set il "issue list --label bug"
# $1 takes the first argument: gt review 13 runs gt pr review 13 --approve
$ gt alias set review 'pr review $1 --approve'
# Replace an existing alias
$ gt alias set il "issue list --assignee @me" --clobber
```
## Options
```
--clobber Replace an existing alias of the same name
-h, --help help for set
```
## 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 alias](../alias/index.md): Create shortcuts for gt commands
cli-docs/reference/api.md
-88
View File
@@ -1,88 +0,0 @@
---
sidebar_position: 3
description: "Make an authenticated Gitea API request"
---
# gt api
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Make an authenticated Gitea API request
## Synopsis
```text
Make an authenticated request to the Gitea API of the selected instance and print
the response.
The endpoint is a path under /api/v1, such as repos/{owner}/{repo}/issues, or a URL of
the instance's API. The placeholders {owner} and {repo} take the repository of the
current directory or --repo, and {branch} the checked-out Git branch.
The method is GET, or POST when fields or --input supply a request body; -X selects
another. Fields become query parameters of GET and HEAD requests and a JSON body
otherwise:
-f, --raw-field name=value a string value
-F, --field name=value a typed value: true, false, null, numbers, arrays and
objects are JSON, @FILE reads a file and @- stdin
--paginate follows the next-page links of a GET request, or asks for the next page of
a list that Gitea counts in X-Total-Count without links, and prints every page on its
own line. --jq filters each JSON response with a jq expression and prints strings
without quotes; jq does not need to be installed.
On a terminal, JSON responses are indented and colored. A response outside 2xx prints
its body, then fails with the HTTP status.
```
```
gt api <endpoint> [flags]
```
## Examples
```
$ gt api user --jq .login
# Create an issue: -f sends strings, -F typed values
$ gt api repos/{owner}/{repo}/issues -f title="Crash on start" -F labels='[3]'
$ gt api user/repos --paginate --jq '.[].full_name'
```
## Options
```
-F, --field key=value Add a typed parameter in key=value format; @FILE or @- reads a file or stdin
-H, --header name:value Add an HTTP request header in name:value format
-h, --help help for api
-i, --include Print the response status and headers to stderr
--input file Read the request body from a file, or stdin with -
--max-pages int Stop --paginate after this many pages; reaching the default fails (default 1000)
-X, --method method HTTP method (default "GET")
--output-file file Write the complete response to a new file
--paginate Follow next-page links and print every page
-f, --raw-field key=value Add a string parameter in key=value format
--silent Do not print the response body
--verbose Print the request and the response status and headers to stderr
```
## 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
cli-docs/reference/auth/index.md
-61
View File
@@ -1,61 +0,0 @@
---
sidebar_position: 4
description: "Authenticate gt and git with Gitea"
---
# gt auth
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Authenticate gt and git with Gitea
## Synopsis
```text
Authenticate gt and git with Gitea.
gt keeps the accounts of each instance in hosts.yml and their tokens in the system
keyring, or in a private file when you choose so. One account per instance is active;
--user or GITEA_CLI_USER selects another for a single command. GITEA_TOKEN, together with
GITEA_CLI_HOST or GITEA_INSTANCE_URL, replaces the stored credentials of its instance for the
active account too; it must belong to the account that --user or GITEA_CLI_USER names. See
gt help environment for how commands select the instance.
```
```
gt auth [flags]
```
## Options
```
-h, --help help for auth
```
## 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 auth login](../auth/login.md): Log in to a Gitea instance
* [gt auth logout](../auth/logout.md): Log out of an account
* [gt auth refresh](../auth/refresh.md): Refresh an OAuth token
* [gt auth setup-git](../auth/setup-git.md): Configure git to use gt for credentials
* [gt auth status](../auth/status.md): Show the accounts gt can use
* [gt auth switch](../auth/switch.md): Switch the active account of an instance
* [gt auth token](../auth/token.md): Print the access token of an account
cli-docs/reference/auth/login.md
-72
View File
@@ -1,72 +0,0 @@
---
sidebar_position: 1
description: "Log in to a Gitea instance"
---
# gt auth login
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Log in to a Gitea instance
## Synopsis
```text
Log in to a Gitea instance. On a terminal without a method flag, gt asks for the instance,
how to log in, where to keep the token and whether git should use gt for the instance.
Create a token on the instance under Settings > Applications. Logging in to an account
that gt already has replaces its stored credential after a confirmation (or with --yes).
```
```
gt auth login [flags]
```
## Examples
```
$ gt auth login
$ gt auth login --host gitea.com --with-token < token.txt
$ gt auth login --host gitea.com --oauth --scopes read:repository,read:user
$ gt auth login --host gitea.example.com --with-token --header 'CF-Access-Client-Id: $CF_ID' --header 'CF-Access-Client-Secret: $CF_SECRET'
```
## Options
```
--client-cert file Present the PEM TLS client certificate in file to an instance that requires one; convert a PKCS#12 file with: openssl pkcs12 -in cert.p12 -clcerts -nokeys -out cert.pem
--client-id ID OAuth application ID registered on the instance (default: the instance's stored ID, then gt's); implies --oauth
--client-key file Unencrypted PEM private key file of --client-cert (default: the key in the --client-cert file); convert a PKCS#12 file with: openssl pkcs12 -in cert.p12 -nocerts -nodes -out key.pem
--credential-store string Where to keep the token {keyring|file} (default "keyring")
--header "Name: value" Send the "Name: value" header with every request to this instance, such as an access proxy needs; a value of $NAME or ${NAME} is read from that environment variable (repeatable)
-h, --help help for login
--insecure Skip TLS certificate verification for this instance
--oauth Authorize in a web browser with OAuth
--scopes scopes OAuth token scopes, such as read:repository (default: write access to everything but administration); implies --oauth
--ssh-agent-key fingerprint Sign requests with the ssh-agent key of fingerprint
--ssh-agent-principal principal Sign requests with the ssh-agent certificate of principal
--ssh-key file Sign requests with the SSH private key in file
--with-token Read an access token from stdin, or ask for it on a terminal
```
## 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 auth](../auth/index.md): Authenticate gt and git with Gitea
cli-docs/reference/auth/logout.md
-58
View File
@@ -1,58 +0,0 @@
---
sidebar_position: 2
description: "Log out of an account"
---
# gt auth logout
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Log out of an account
## Synopsis
```text
Log out of an account: gt forgets the account and deletes its stored credential. Git's
other credential helpers are asked to forget what they stored for the account on the
instance, such as a copy of its token that a keychain kept after a push.
```
```
gt auth logout [<user>] [flags]
```
## Examples
```
$ gt auth logout
$ gt auth logout bob --host gitea.com
# Without confirmation
$ gt auth logout alice --yes
```
## Options
```
-h, --help help for logout
```
## 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 auth](../auth/index.md): Authenticate gt and git with Gitea
cli-docs/reference/auth/refresh.md
-56
View File
@@ -1,56 +0,0 @@
---
sidebar_position: 3
description: "Refresh an OAuth token"
---
# gt auth refresh
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Refresh an OAuth token
## Synopsis
```text
Refresh the OAuth token of the active account, or of --user, now. gt refreshes expiring
OAuth tokens on its own; tokens pasted with --with-token cannot be refreshed and are
replaced by logging in again.
```
```
gt auth refresh [flags]
```
## Examples
```
$ gt auth refresh
$ gt auth refresh --host gitea.com --user alice
```
## Options
```
-h, --help help for refresh
```
## 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 auth](../auth/index.md): Authenticate gt and git with Gitea
cli-docs/reference/auth/setup-git.md
-63
View File
@@ -1,63 +0,0 @@
---
sidebar_position: 4
description: "Configure git to use gt for credentials"
---
# gt auth setup-git
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Configure git to use gt for credentials
## Synopsis
```text
Configure git to ask gt for the credentials of an instance, so that git push and fetch
over HTTPS use the active account, or the account of --user. gt's own clone and checkout
commands do not need this.
Other credential helpers, such as a system keychain, are turned off for the instance:
otherwise they answer first and keep a copy of gt's token. --keep-helpers keeps them.
```
```
gt auth setup-git [flags]
```
## Examples
```
$ gt auth setup-git
$ gt auth setup-git --host gitea.com
# Only for the current repository, always as alice
$ gt auth setup-git --local --user alice
```
## Options
```
-h, --help help for setup-git
--keep-helpers Keep other credential helpers for the instance; they are asked first and store gt's token
--local Configure only the current Git repository instead of global Git configuration
```
## 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 auth](../auth/index.md): Authenticate gt and git with Gitea
cli-docs/reference/auth/status.md
-59
View File
@@ -1,59 +0,0 @@
---
sidebar_position: 5
description: "Show the accounts gt can use"
---
# gt auth status
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Show the accounts gt can use
## Synopsis
```text
Show the accounts gt can use on each instance, the active one, and how they
authenticate. Fails with exit code 4 when there is no account, or when a credential is
missing or rejected. With --json it exits 0 either way; read credential_available, verified and error.
```
```
gt auth status [flags]
```
## Examples
```
$ gt auth status
# Check the credentials against their instances
$ gt auth status --verify
$ gt auth status --host gitea.com --json
```
## Options
```
-h, --help help for status
--verify Check each credential against its instance
```
## 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 auth](../auth/index.md): Authenticate gt and git with Gitea
cli-docs/reference/auth/switch.md
-57
View File
@@ -1,57 +0,0 @@
---
sidebar_position: 6
description: "Switch the active account of an instance"
---
# gt auth switch
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Switch the active account of an instance
## Synopsis
```text
Switch the active account of an instance, which commands use unless --user or GITEA_CLI_USER
selects another. With two accounts, gt auth switch toggles between them; with more, it
asks which one on a terminal.
```
```
gt auth switch [<user>] [flags]
```
## Examples
```
$ gt auth switch
$ gt auth switch bob
$ gt auth switch bob --host gitea.com
```
## Options
```
-h, --help help for switch
```
## 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 auth](../auth/index.md): Authenticate gt and git with Gitea
cli-docs/reference/auth/token.md
-58
View File
@@ -1,58 +0,0 @@
---
sidebar_position: 7
description: "Print the access token of an account"
---
# gt auth token
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Print the access token of an account
## Synopsis
```text
Print the access token that gt uses for the active account, or for --user, so that
scripts can call the API themselves. The GITEA_TOKEN of the instance takes precedence, as
it does for other commands, and an expiring OAuth token is refreshed first. Accounts that
sign requests with an SSH key have no token.
```
```
gt auth token [flags]
```
## Examples
```
$ gt auth token
$ curl -H "Authorization: token $(gt auth token)" https://gitea.com/api/v1/user
$ gt auth token --host gitea.com --user alice
```
## Options
```
-h, --help help for token
```
## 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 auth](../auth/index.md): Authenticate gt and git with Gitea
cli-docs/reference/branch/create.md
-59
View File
@@ -1,59 +0,0 @@
---
sidebar_position: 1
description: "Create a branch"
---
# gt branch create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create a branch
## Synopsis
```text
Create a branch on the server from another branch, a tag or a commit; the default branch unless --source names one.
```
```
gt branch create <branch> [flags]
```
## Examples
```
# Branch off the default branch
$ gt branch create feature/login
# Branch off a tag or a commit
$ gt branch create hotfix/1.0.1 --source v1.0.0
$ gt branch create bisect --source 3f2a9c1
```
## Options
```
-h, --help help for create
-s, --source string Branch, tag or commit to start from (default: the default branch)
```
## 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 branch](../branch/index.md): Manage remote branches and protection rules
cli-docs/reference/branch/delete.md
-48
View File
@@ -1,48 +0,0 @@
---
sidebar_position: 2
description: "Delete branches"
---
# gt branch delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete branches
```
gt branch delete <branch>... [flags]
```
## Examples
```
$ gt branch delete feature/login
$ gt branch delete old-a old-b --yes
```
## Options
```
-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 branch](../branch/index.md): Manage remote branches and protection rules
cli-docs/reference/branch/index.md
-55
View File
@@ -1,55 +0,0 @@
---
sidebar_position: 5
description: "Manage remote branches and protection rules"
---
# gt branch
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage remote branches and protection rules
## Synopsis
```text
Work with the branches of a repository on the server: list and view them, create, rename and
delete them, and protect them from direct pushes. To work with local branches, use git.
```
```
gt branch [flags]
```
## Options
```
-h, --help help for branch
```
## 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 branch create](../branch/create.md): Create a branch
* [gt branch delete](../branch/delete.md): Delete branches
* [gt branch list](../branch/list.md): List branches
* [gt branch protect](../branch/protect.md): Protect branches
* [gt branch rename](../branch/rename.md): Rename a branch
* [gt branch unprotect](../branch/unprotect.md): Remove branch protection
* [gt branch view](../branch/view.md): View a branch
cli-docs/reference/branch/list.md
-50
View File
@@ -1,50 +0,0 @@
---
sidebar_position: 3
description: "List branches"
---
# gt branch list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List branches
```
gt branch list [flags]
```
## Examples
```
$ gt branch list
$ gt branch list -R alice/project --limit 100 --json name,sha
```
## 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 branch](../branch/index.md): Manage remote branches and protection rules
cli-docs/reference/branch/protect.md
-67
View File
@@ -1,67 +0,0 @@
---
sidebar_position: 4
description: "Protect branches"
---
# gt branch protect
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Protect branches
## Synopsis
```text
Add a protection rule for each existing branch, or with --pattern for every branch matching a
glob. By default nobody can push directly and pull requests need one approving review.
When a branch or pattern has a rule already, change only the settings the flags name and keep
the others; --allow-push replaces those who may push directly.
```
```
gt branch protect <branch>... [flags]
```
## Examples
```
# Require two approvals and passing CI on main
$ gt branch protect main --required-approvals 2 --status-check ci/build
# Let the release team push to every release branch
$ gt branch protect --pattern 'release/*' --allow-push acme/release
```
## Options
```
--allow-push strings Users, or teams as ORG/TEAM, that may push directly
--block-on-rejected-reviews Block merging while changes are requested
--dismiss-stale-approvals Dismiss approvals when new commits are pushed
-h, --help help for protect
--pattern string Protect the branches matching this glob, such as release/*
--required-approvals int Approving reviews that pull requests need (default 1)
--status-check strings Status checks that must pass (repeatable)
```
## 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 branch](../branch/index.md): Manage remote branches and protection rules
cli-docs/reference/branch/rename.md
-47
View File
@@ -1,47 +0,0 @@
---
sidebar_position: 5
description: "Rename a branch"
---
# gt branch rename
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Rename a branch
```
gt branch rename <branch> <new-name> [flags]
```
## Examples
```
$ gt branch rename feature/logn feature/login
```
## Options
```
-h, --help help for rename
```
## 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 branch](../branch/index.md): Manage remote branches and protection rules
cli-docs/reference/branch/unprotect.md
-54
View File
@@ -1,54 +0,0 @@
---
sidebar_position: 6
description: "Remove branch protection"
---
# gt branch unprotect
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Remove branch protection
## Synopsis
```text
Remove the protection rules of branches, or of glob patterns such as release/*.
```
```
gt branch unprotect <branch>... [flags]
```
## Examples
```
$ gt branch unprotect main
$ gt branch unprotect 'release/*' --yes
```
## Options
```
-h, --help help for unprotect
```
## 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 branch](../branch/index.md): Manage remote branches and protection rules
cli-docs/reference/branch/view.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 7
description: "View a branch"
---
# gt branch view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View a branch
```
gt branch view <branch> [flags]
```
## Examples
```
$ gt branch view main
$ gt branch view feature/login --web
```
## Options
```
-h, --help help for view
-w, --web Open the branch in the browser
```
## 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 branch](../branch/index.md): Manage remote branches and protection rules
cli-docs/reference/completion/bash.md
-57
View File
@@ -1,57 +0,0 @@
---
sidebar_position: 1
description: "Generate the autocompletion script for bash"
---
# gt completion bash
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for bash
## Synopsis
```text
Generate the completion script for bash. It needs the bash-completion package.
To load completions in every new shell, add the eval line below to ~/.bashrc (on macOS,
~/.bash_profile); bash 3.2, the default on macOS, cannot source <(gt completion bash).
```
```
gt completion bash
```
## Examples
```
$ eval "$(gt completion bash)"
```
## Options
```
-h, --help help for bash
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts
cli-docs/reference/completion/fish.md
-64
View File
@@ -1,64 +0,0 @@
---
sidebar_position: 2
description: "Generate the autocompletion script for fish"
---
# gt completion fish
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for fish
## Synopsis
```text
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
gt completion fish | source
To load completions for every new session, execute once:
gt completion fish > ~/.config/fish/completions/gt.fish
You will need to start a new shell for this setup to take effect.
```
```
gt completion fish [flags]
```
## Examples
```
$ gt completion fish > ~/.config/fish/completions/gt.fish
```
## Options
```
-h, --help help for fish
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts
cli-docs/reference/completion/index.md
-52
View File
@@ -1,52 +0,0 @@
---
sidebar_position: 6
description: "Generate shell completion scripts"
---
# gt completion
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate shell completion scripts
## Synopsis
```text
Generate the autocompletion script for gt for the specified shell.
See each sub-command's help for details on how to use the generated script.
```
```
gt completion [flags]
```
## Options
```
-h, --help help for completion
```
## 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 completion bash](../completion/bash.md): Generate the autocompletion script for bash
* [gt completion fish](../completion/fish.md): Generate the autocompletion script for fish
* [gt completion powershell](../completion/powershell.md): Generate the autocompletion script for powershell
* [gt completion zsh](../completion/zsh.md): Generate the autocompletion script for zsh
cli-docs/reference/completion/powershell.md
-61
View File
@@ -1,61 +0,0 @@
---
sidebar_position: 3
description: "Generate the autocompletion script for powershell"
---
# gt completion powershell
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for powershell
## Synopsis
```text
Generate the autocompletion script for powershell.
To load completions in your current shell session:
gt completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
```
```
gt completion powershell [flags]
```
## Examples
```
$ gt completion powershell | Out-String | Invoke-Expression
```
## Options
```
-h, --help help for powershell
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts
cli-docs/reference/completion/zsh.md
-75
View File
@@ -1,75 +0,0 @@
---
sidebar_position: 4
description: "Generate the autocompletion script for zsh"
---
# gt completion zsh
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for zsh
## Synopsis
```text
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(gt completion zsh)
To load completions for every new session, execute once:
#### Linux:
gt completion zsh > "${fpath[1]}/_gt"
#### macOS:
gt completion zsh > $(brew --prefix)/share/zsh/site-functions/_gt
You will need to start a new shell for this setup to take effect.
```
```
gt completion zsh [flags]
```
## Examples
```
$ source <(gt completion zsh)
```
## Options
```
-h, --help help for zsh
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts
cli-docs/reference/config/get.md
-50
View File
@@ -1,50 +0,0 @@
---
sidebar_position: 1
description: "Print the value of a setting"
---
# gt config get
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Print the value of a setting
```
gt config get <key> [flags]
```
## Examples
```
$ gt config get editor
$ gt config get default_host --show-source
$ gt config get ssh_key --host https://gitea.com --user alice
```
## Options
```
-h, --help help for get
--show-source Also print where the value comes from
```
## 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 config](../config/index.md): Manage settings
cli-docs/reference/config/index.md
-63
View File
@@ -1,63 +0,0 @@
---
sidebar_position: 7
description: "Manage settings"
---
# gt config
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage settings
## Synopsis
```text
Manage gt's settings.
Preferences live in config.yml and instance settings in hosts.yml, in the configuration
directory ($GITEA_CLI_CONFIG_DIR, or gitea-cli under the XDG config directory); gt config path prints
both files. Environment variables that override settings are listed in gt help environment.
Preferences: default_host, git_protocol, editor, prompt (enabled or disabled), pager,
browser (never disables opening), color, hyperlinks and markdown (auto or raw), remote,
http_timeout and aliases (see gt alias).
Instance settings (--host <url>): user, ssh_host, insecure, git_protocol, oauth_client_id,
headers, client_cert and client_key.
Account settings (--host <url> --user <name>): ssh_key, ssh_agent,
ssh_certificate_principal, ssh_key_fingerprint.
```
```
gt config [flags]
```
## Options
```
-h, --help help for config
```
## 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 config get](../config/get.md): Print the value of a setting
* [gt config list](../config/list.md): List settings and their values
* [gt config path](../config/path.md): Print the paths of the settings files
* [gt config set](../config/set.md): Change a setting
cli-docs/reference/config/list.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 2
description: "List settings and their values"
---
# gt config list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List settings and their values
```
gt config list [flags]
```
## Examples
```
$ gt config list
# Include the settings of an instance
$ gt config list --host https://gitea.com
```
## Options
```
-h, --help help for list
```
## 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 config](../config/index.md): Manage settings
cli-docs/reference/config/path.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 3
description: "Print the paths of the settings files"
---
# gt config path
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Print the paths of the settings files
```
gt config path [flags]
```
## Examples
```
$ gt config path
# Settings of another configuration directory
$ GITEA_CLI_CONFIG_DIR=~/work/gt gt config path
```
## Options
```
-h, --help help for path
```
## 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 config](../config/index.md): Manage settings
cli-docs/reference/config/set.md
-80
View File
@@ -1,80 +0,0 @@
---
sidebar_position: 4
description: "Change a setting"
---
# gt config set
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Change a setting
## Synopsis
```text
Change a preference, an instance setting (--host) or an account setting (--host and --user).
Preferences:
default_host instance to use when no flag or repository selects one
git_protocol https or ssh, for clones and remotes
editor command that edits bodies and messages, such as "code --wait"
prompt enabled or disabled; disabled turns prompts off
pager command that pages long output on a terminal; GITEA_CLI_PAGER overrides it
browser command that opens URLs; never disables opening
color auto, always or never
hyperlinks auto, always or never, for clickable links in terminals
markdown auto renders Markdown on a terminal, raw prints the source
remote Git remote used to find the repository of a clone
http_timeout longest wait for the instance to answer a request, such as 30s, or for more
data while a transfer stalls; 0 waits as long as it takes; a transfer that
keeps moving and migrations are not cut off. The wait for an answer starts
once an upload has reached the instance's machine, so an instance that reads
uploads slowly from its connection needs a longer timeout
Instance settings: user (active account), ssh_host, insecure, git_protocol, oauth_client_id,
and headers: "Name: value" adds a header to every API request to the instance, such as an
access proxy needs, "Name:" removes it, and a value of $NAME or ${NAME} is read from that
environment variable when sent; client_cert and client_key name the PEM files of a TLS client
certificate for an instance that requires one; without client_key, the key is read from
client_cert.
Account settings: ssh_key, ssh_agent, ssh_certificate_principal, ssh_key_fingerprint.
```
```
gt config set <key> <value> [flags]
```
## Examples
```
$ gt config set editor "code --wait"
$ gt config set ssh_host git.example.com:2222 --host https://example.com
$ gt config set ssh_key ~/.ssh/id_ed25519 --host https://example.com --user alice
```
## Options
```
-h, --help help for set
```
## 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 config](../config/index.md): Manage settings
cli-docs/reference/doctor.md
-59
View File
@@ -1,59 +0,0 @@
---
sidebar_position: 8
description: "Check gt's setup for this directory"
---
# gt doctor
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Check gt's setup for this directory
## Synopsis
```text
Check the setup that commands in this directory use: the settings files, the instance,
its configured headers and whether it answers, the account and its credential, the
repository, and Git. Each problem comes with the command that fixes it. gt doctor fails
when a check fails.
```
```
gt doctor [flags]
```
## Examples
```
$ gt doctor
# Check another repository and instance
$ gt doctor -R gitea.com/gitea/cli
$ gt doctor --jq '.checks[] | select(.status == "failed")'
```
## Options
```
-h, --help help for doctor
```
## 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
cli-docs/reference/help/environment.md
-91
View File
@@ -1,91 +0,0 @@
---
sidebar_position: 1
description: "Environment variables and global flags"
---
# gt help environment
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Environment variables and global flags
## Synopsis
```text
Global flags work with every command, before or after the command name:
--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
gt selects the repository from --repo, GITEA_CLI_REPO, git config gt.repository (gt repo
set-default) or a Git remote (--remote, else the base remote pr checkout recorded, the
current branch's remote, upstream or origin, skipping remotes on instances without an
account, or not on --host or the GITEA_TOKEN instance). Like gh, a clone with upstream
and origin targets upstream: a branch tracking origin does not select the fork,
and the instance from the repository URL, --host, GITEA_CLI_HOST or GITEA_INSTANCE_URL,
default_host, the only configured instance, or, among several, the instance of the clone's
repository.
Environment variables:
GITEA_CLI_CONFIG_DIR configuration directory; gt config path prints the files
GITEA_CLI_HOST, GITEA_INSTANCE_URL instance URL, overriding default_host
GITEA_TOKEN access token for that instance instead of stored credentials
GITEA_INSTANCE_INSECURE with GITEA_TOKEN, skip TLS verification when true
GITEA_INSTANCE_SSH_HOST with GITEA_TOKEN, SSH host that identifies the instance's remotes
GITEA_CLI_USER account on the selected instance, like --user
GITEA_CLI_REPO repository as OWNER/REPO or URL, like --repo
GITEA_CLI_EDITOR editor, overriding config.yml
GITEA_CLI_PAGER pager, overriding config.yml
GITEA_CLI_COLOR color preference: auto, always or never
GITEA_CLI_HTTP_TIMEOUT longest wait for an answer, overriding config.yml
NO_COLOR disables automatic color when set, even with CLICOLOR_FORCE
CLICOLOR_FORCE unless empty or 0, colors stderr, even when redirected, and
a terminal stdout despite CLICOLOR=0 or TERM=dumb
CLICOLOR disables automatic color on a terminal when 0
VISUAL, EDITOR, PAGER, BROWSER editor (VISUAL first), pager and browser when config.yml sets none
TERM dumb asks each prompt as a line of text, for screen readers,
and turns off automatic color
Piped or redirected stdout is data: the color settings never color it. Only a
command's own --color always does, such as gt pr diff --color always.
Preferences in config.yml are described in gt config --help.
```
## Options
```
-h, --help help for environment
```
## 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
cli-docs/reference/help/exit-codes.md
-53
View File
@@ -1,53 +0,0 @@
---
sidebar_position: 2
description: "Exit codes used by gt"
---
# gt help exit-codes
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Exit codes used by gt
## Synopsis
```text
gt exits with one of these codes:
0 success, including an empty list
1 the command failed
2 usage error: an unknown command or flag, or a missing or invalid argument
3 canceled: a declined confirmation, a prompt left with Esc or Ctrl-D, or a timeout
4 authentication is missing or was rejected
8 gt pr checks: some checks are still pending
130 interrupted with Ctrl-C, also at a prompt
A command may document further codes in its help.
```
## Options
```
-h, --help help for exit-codes
```
## 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
cli-docs/reference/help/formatting.md
-65
View File
@@ -1,65 +0,0 @@
---
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
cli-docs/reference/help/index.md
-14
View File
@@ -1,14 +0,0 @@
---
sidebar_position: 30
description: "Guides built into gt, read with gt help <topic>."
---
# Help topics
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Guides built into gt, read with `gt help <topic>`:
- [gt help environment](environment.md): Environment variables and global flags
- [gt help exit-codes](exit-codes.md): Exit codes used by gt
- [gt help formatting](formatting.md): JSON output with --json and --jq
cli-docs/reference/index.md
-74
View File
@@ -1,74 +0,0 @@
---
sidebar_position: 0
description: "Work with Gitea from your terminal"
---
# Command reference
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Every `gt` command and flag, generated from the `--help` output of gt's main branch
or release. Global flags work with every command; [gt help environment](help/environment.md)
describes them together with the environment variables gt reads.
Work with Gitea from your terminal
## Synopsis
```text
Work seamlessly with Gitea from the command line.
```
```
gt [flags]
```
## Options
```
--cwd directory Working directory for repository discovery
--debug Log the method, URL, status, and duration of each HTTP request to stderr
-h, --help help for gt
--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 admin](admin/index.md): Manage instance administration
* [gt alias](alias/index.md): Create shortcuts for gt commands
* [gt api](api.md): Make an authenticated Gitea API request
* [gt auth](auth/index.md): Authenticate gt and git with Gitea
* [gt branch](branch/index.md): Manage remote branches and protection rules
* [gt completion](completion/index.md): Generate shell completion scripts
* [gt config](config/index.md): Manage settings
* [gt doctor](doctor.md): Check gt's setup for this directory
* [gt issue](issue/index.md): Manage issues
* [gt label](label/index.md): Manage labels
* [gt milestone](milestone/index.md): Manage milestones
* [gt notification](notification/index.md): Read and triage your notifications
* [gt org](org/index.md): Manage organizations
* [gt package](package/index.md): Manage packages
* [gt pr](pr/index.md): Manage pull requests
* [gt release](release/index.md): Manage releases
* [gt repo](repo/index.md): Work with Gitea repositories
* [gt run](run/index.md): View and manage Actions workflow runs
* [gt search](search/index.md): Search within one selected Gitea instance
* [gt secret](secret/index.md): Manage Actions secrets for a repository, organization, or your account
* [gt ssh-key](ssh-key/index.md): Manage SSH keys
* [gt status](status.md): Show your work across repositories
* [gt team](team/index.md): Manage organization teams and access
* [gt time](time/index.md): Track time spent on issues and pull requests
* [gt variable](variable/index.md): Manage Actions variables for a repository, organization, or your account
* [gt version](version.md): Print gt's version
* [gt webhook](webhook/index.md): Manage webhooks
* [gt wiki](wiki/index.md): Manage repository wiki pages
* [gt workflow](workflow/index.md): View, run, enable and disable Actions workflows
cli-docs/reference/issue/attachment/delete.md
-47
View File
@@ -1,47 +0,0 @@
---
sidebar_position: 1
description: "Delete an attachment"
---
# gt issue attachment delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete an attachment
```
gt issue attachment delete {<number> | <url>} <attachment-id> [flags]
```
## Examples
```
$ gt issue attachment delete 12 9 --yes
```
## Options
```
-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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
cli-docs/reference/issue/attachment/download.md
-62
View File
@@ -1,62 +0,0 @@
---
sidebar_position: 2
description: "Download an attachment"
---
# gt issue attachment download
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Download an attachment
## Synopsis
```text
Download an attachment into the current directory under its own name, or where -O/--output
or -D/--dir say. An existing file is kept unless --clobber replaces it or --skip-existing
skips the download.
```
```
gt issue attachment download {<number> | <url>} <attachment-id> [flags]
```
## Examples
```
$ gt issue attachment download 12 9
$ gt issue attachment download 12 9 --output crash.log --clobber
# Write the file to standard output
$ gt issue attachment download 12 9 -O - | less
```
## Options
```
--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)
--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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
cli-docs/reference/issue/attachment/edit.md
-48
View File
@@ -1,48 +0,0 @@
---
sidebar_position: 3
description: "Rename an attachment"
---
# gt issue attachment edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Rename an attachment
```
gt issue attachment edit {<number> | <url>} <attachment-id> [flags]
```
## Examples
```
$ gt issue attachment edit 12 9 --name crash-2026-10-11.log
```
## Options
```
-h, --help help for edit
--name name New file 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
cli-docs/reference/issue/attachment/index.md
-54
View File
@@ -1,54 +0,0 @@
---
sidebar_position: 1
description: "Manage the attachments of issues"
---
# gt issue attachment
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage the attachments of issues
## Synopsis
```text
List, view, upload, download, rename and delete the files attached to an issue. Attachments
are addressed by the issue number and the attachment ID that attachment list shows.
```
```
gt issue attachment [flags]
```
## Options
```
-h, --help help for attachment
```
## 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 issue](../../issue/index.md): Manage issues
* [gt issue attachment delete](../../issue/attachment/delete.md): Delete an attachment
* [gt issue attachment download](../../issue/attachment/download.md): Download an attachment
* [gt issue attachment edit](../../issue/attachment/edit.md): Rename an attachment
* [gt issue attachment list](../../issue/attachment/list.md): List attachments
* [gt issue attachment upload](../../issue/attachment/upload.md): Attach a file
* [gt issue attachment view](../../issue/attachment/view.md): View an attachment
cli-docs/reference/issue/attachment/list.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 4
description: "List attachments"
---
# gt issue attachment list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List attachments
```
gt issue attachment list {<number> | <url>} [flags]
```
## Examples
```
$ gt issue attachment list 12
```
## 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
cli-docs/reference/issue/attachment/upload.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 5
description: "Attach a file"
---
# gt issue attachment upload
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Attach a file
```
gt issue attachment upload {<number> | <url>} <file> [flags]
```
## Examples
```
$ gt issue attachment upload 12 crash.log
$ gt issue attachment upload 12 screenshot.png --name before.png
```
## Options
```
-h, --help help for upload
--name name File name of the attachment (default: the local file 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
cli-docs/reference/issue/attachment/view.md
-47
View File
@@ -1,47 +0,0 @@
---
sidebar_position: 6
description: "View an attachment"
---
# gt issue attachment view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View an attachment
```
gt issue attachment view {<number> | <url>} <attachment-id> [flags]
```
## Examples
```
$ gt issue attachment view 12 9
```
## Options
```
-h, --help help for view
```
## 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
cli-docs/reference/issue/close.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 2
description: "Close issues"
---
# gt issue close
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Close issues
```
gt issue close {<number> | <url>}... [flags]
```
## Examples
```
$ gt issue close 12
$ gt issue close 12 13 --comment "Done in #14"
```
## Options
```
-c, --comment string Leave a comment before closing the issue
-h, --help help for close
```
## 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 issue](../issue/index.md): Manage issues
cli-docs/reference/issue/comment/create.md
-52
View File
@@ -1,52 +0,0 @@
---
sidebar_position: 1
description: "Add a comment to an issue"
---
# gt issue comment create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Add a comment to an issue
```
gt issue comment create {<number> | <url>} [flags]
```
## Examples
```
$ gt issue comment create 12 --body "Looks good"
$ gt issue comment add 12 --editor
```
## Options
```
--attachment File File to attach to the comment (repeatable)
-b, --body text Comment text
-F, --body-file file Read the comment from file, or - for stdin
-e, --editor Write the comment in the configured editor
-h, --help help for create
```
## 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 issue comment](../../issue/comment/index.md): Add a comment to an issue
cli-docs/reference/issue/comment/delete.md
-47
View File
@@ -1,47 +0,0 @@
---
sidebar_position: 2
description: "Delete a comment"
---
# gt issue comment delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete a comment
```
gt issue comment delete <comment-id> [flags]
```
## Examples
```
$ gt issue comment delete 81 --yes
```
## Options
```
-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 issue comment](../../issue/comment/index.md): Add a comment to an issue
cli-docs/reference/issue/comment/edit.md
-58
View File
@@ -1,58 +0,0 @@
---
sidebar_position: 3
description: "Edit a comment"
---
# gt issue comment edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit a comment
## Synopsis
```text
Replace the text of a comment. Without --body or --body-file, the editor or the prompt starts
from the current text.
```
```
gt issue comment edit <comment-id> [flags]
```
## Examples
```
$ gt issue comment edit 81 --body "Fixed in #15"
$ gt issue comment edit 81
```
## Options
```
-b, --body text Comment text
-F, --body-file file Read the comment from file, or - for stdin
-e, --editor Write the comment in the configured editor
-h, --help help for edit
```
## 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 issue comment](../../issue/comment/index.md): Add a comment to an issue
cli-docs/reference/issue/comment/index.md
-69
View File
@@ -1,69 +0,0 @@
---
sidebar_position: 3
description: "Add a comment to an issue"
---
# gt issue comment
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Add a comment to an issue
## Synopsis
```text
Add a comment to an issue, or edit or delete your last comment on it.
Without --body, --body-file or --editor, the configured editor opens, or a multi-line prompt
asks for the comment. The subcommands list, view, edit and delete comments by their ID.
```
```
gt issue comment {<number> | <url>} [flags]
```
## Examples
```
$ gt issue comment 12 --body "Fixed in #14"
$ gt issue comment 12 --edit-last --body "Fixed in #15"
$ gt issue comment list 12
```
## Options
```
--attachment File File to attach to the comment (repeatable)
-b, --body text Comment text
-F, --body-file file Read the comment from file, or - for stdin
--delete-last Delete your last comment
--edit-last Edit your last comment instead of adding one
-e, --editor Write the comment in the configured editor
-h, --help help for comment
```
## 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 issue](../../issue/index.md): Manage issues
* [gt issue comment create](../../issue/comment/create.md): Add a comment to an issue
* [gt issue comment delete](../../issue/comment/delete.md): Delete a comment
* [gt issue comment edit](../../issue/comment/edit.md): Edit a comment
* [gt issue comment list](../../issue/comment/list.md): List the comments on an issue
* [gt issue comment view](../../issue/comment/view.md): View a comment
cli-docs/reference/issue/comment/list.md
-50
View File
@@ -1,50 +0,0 @@
---
sidebar_position: 4
description: "List the comments on an issue"
---
# gt issue comment list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List the comments on an issue
```
gt issue comment list {<number> | <url>} [flags]
```
## Examples
```
$ gt issue comment list 12
$ gt issue comment list 12 --json id,author,body
```
## 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 issue comment](../../issue/comment/index.md): Add a comment to an issue
cli-docs/reference/issue/comment/view.md
-47
View File
@@ -1,47 +0,0 @@
---
sidebar_position: 5
description: "View a comment"
---
# gt issue comment view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View a comment
```
gt issue comment view <comment-id> [flags]
```
## Examples
```
$ gt issue comment view 81
```
## Options
```
-h, --help help for view
```
## 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 issue comment](../../issue/comment/index.md): Add a comment to an issue
cli-docs/reference/issue/create.md
-82
View File
@@ -1,82 +0,0 @@
---
sidebar_position: 4
description: "Create an issue"
---
# gt issue create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create an issue
## Synopsis
```text
Create an issue in a repository. Without flags on a terminal, a form asks for the title and
body, then optionally for assignees, a milestone, labels and a due date.
Gitea sets labels, a milestone, assignees and a due date only for people who can write to the
issues of the repository, and creates the issue without them for others: gt then names the
flags or form fields it left out and fails, and warns about left-out labels of a template.
Adding the issue to a project needs write access too; when that fails, the issue stays created
and the error names the command that adds it later.
--template starts from a repository issue template: its title, body, labels and ref. --title,
--label, --body, --body-file and --ref replace them; labels the repository lacks are left out.
A form (YAML) template starts with an empty body. On a terminal the form opens with the title
and body, and a template picked in the form applies its labels too. The title of a template is
a prefix to complete, so without the form --template requires --title. --web opens the
new-issue page with the whole template applied.
```
```
gt issue create [flags]
```
## Examples
```
$ gt issue create
$ gt issue create --title "Crash on start" --body "Steps to reproduce…" --label bug --milestone v1.0
$ gt issue create --template "Bug report"
```
## Options
```
-a, --assignee login Assign people by their login; @me for yourself
--attachment File File to attach after creation (repeatable)
-b, --body string Issue body
-F, --body-file file Read body from file, or - for stdin
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC
-e, --editor Compose the issue body in the configured editor
-h, --help help for create
-l, --label name Add labels by name; prefix repo: or org: to disambiguate
-m, --milestone title Add the issue to a milestone by title or ID
-p, --project title Add the issue to the project with this title, the repository's or its organization's (repeatable)
--ref string Branch or tag the issue refers to
-T, --template name Start from the repository issue template with this name
-t, --title string Issue title
-w, --web Continue in the browser with the new-issue page
```
## 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 issue](../issue/index.md): Manage issues
cli-docs/reference/issue/edit.md
-82
View File
@@ -1,82 +0,0 @@
---
sidebar_position: 5
description: "Edit issues: title, body, labels, assignees, milestone, deadline"
---
# gt issue edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit issues: title, body, labels, assignees, milestone, deadline
## Synopsis
```text
Edit one or more issues. Without flags on a terminal, a form edits one issue at a time,
starting from its current values. Label and assignee flags add to or remove from each issue's
current values; the --set flags replace them. The blocked_by and blocks JSON fields cost extra
requests, made only when the output includes them (see gt help formatting).
Gitea changes the milestone, assignees and due date only for people who can write to the issues
of the repository, and leaves them as they were for the author of an issue who cannot: gt then
names the flags or form fields it left out and fails. Gitea refuses their label changes outright,
so gt sends the other changes first.
```
```
gt issue edit {<number> | <url>}... [flags]
```
## Examples
```
$ gt issue edit 12 --title "Crash on start" --add-label bug
$ gt issue edit 12 13 --add-assignee @me --milestone v1.0
$ gt issue edit 12 --remove-label wontfix --remove-milestone
$ gt issue edit 12 --add-blocked-by 9
```
## Options
```
--add-assignee login Add assignees by login; @me for yourself
--add-blocked-by issues Mark the issue as blocked by other issues: N, #N, OWNER/REPO#N or a URL
--add-label name Add labels by name; prefix repo: or org: to disambiguate
--add-project title Add the issue to the project with this title (repeatable)
-b, --body string New body; empty clears it
-F, --body-file file Read the body from file, or - for stdin
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC; empty clears it
-e, --editor Edit the current body in the configured editor
-h, --help help for edit
-m, --milestone title Move the issue to a milestone by title or ID
--ref string Branch or tag the issue refers to; empty clears it
--remove-assignee login Remove assignees by login; @me for yourself
--remove-blocked-by issues Lift the dependency on other issues: N, #N, OWNER/REPO#N or a URL
--remove-label name Remove labels by name
--remove-milestone Remove the issue from its milestone
--remove-project title Take the issue off the project with this title (repeatable)
--set-assignees strings Replace all assignees; an empty value clears them
--set-labels strings Replace all labels; an empty value clears them
-t, --title string New title
```
## 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 issue](../issue/index.md): Manage issues
cli-docs/reference/issue/index.md
-58
View File
@@ -1,58 +0,0 @@
---
sidebar_position: 9
description: "Manage issues"
---
# gt issue
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage issues
## Synopsis
```text
Work with the issues of a repository: list, view and create them, edit, close or reopen
one or more, and comment on them. Gitea lists pull requests among issues, so most issue
commands also accept a pull request number.
```
```
gt issue [flags]
```
## Options
```
-h, --help help for issue
```
## 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 issue attachment](../issue/attachment/index.md): Manage the attachments of issues
* [gt issue close](../issue/close.md): Close issues
* [gt issue comment](../issue/comment/index.md): Add a comment to an issue
* [gt issue create](../issue/create.md): Create an issue
* [gt issue edit](../issue/edit.md): Edit issues: title, body, labels, assignees, milestone, deadline
* [gt issue list](../issue/list.md): List issues in a repository
* [gt issue reopen](../issue/reopen.md): Reopen issues
* [gt issue timeline](../issue/timeline.md): Show the activity on an issue
* [gt issue view](../issue/view.md): View an issue
cli-docs/reference/issue/list.md
-72
View File
@@ -1,72 +0,0 @@
---
sidebar_position: 6
description: "List issues in a repository"
---
# gt issue list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List issues in a repository
## Synopsis
```text
List the issues of a repository, newest first. Filters combine: an issue must match all of them.
Labels and milestones must exist in the repository.
```
```
gt issue list [flags]
```
## Examples
```
$ gt issue list --label bug --state all
$ gt issue list --assignee @me --json number,title
$ gt issue list --no-assignee --label bug
# Issues and pull requests in a milestone, as tab-separated values
$ gt issue list --kind all --milestone v1.0 | cut -f1,2
```
## Options
```
-a, --assignee string Filter by assignee; @me for yourself
-A, --author string Filter by author; @me for yourself
-h, --help help for list
--kind string List issues, pull requests or both; the kind field of each reads issue or pull {issues|pulls|all} (default "issues")
-l, --label names Filter by label names
-L, --limit int Maximum number of results (1..1000) (default 30)
--mentions string Filter by mentioned user; @me for yourself
-m, --milestone titles Filter by milestone titles or IDs, comma-separated
--no-assignee Only issues without an assignee
--page int Result page (default 1)
-S, --search string Search issue titles and bodies
--since string Updated since a date, timestamp, or duration ago
-s, --state string Filter by state {open|closed|all} (default "open")
--until string Updated before a date, timestamp, or duration ago
-w, --web Open the issue list in the browser
```
## 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 issue](../issue/index.md): Manage issues
cli-docs/reference/issue/reopen.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 7
description: "Reopen issues"
---
# gt issue reopen
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Reopen issues
```
gt issue reopen {<number> | <url>}... [flags]
```
## Examples
```
$ gt issue reopen 12
$ gt issue reopen 12 13 --comment "Still happens on v1.2"
```
## Options
```
-c, --comment string Leave a comment before reopening the issue
-h, --help help for reopen
```
## 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 issue](../issue/index.md): Manage issues
cli-docs/reference/issue/timeline.md
-57
View File
@@ -1,57 +0,0 @@
---
sidebar_position: 8
description: "Show the activity on an issue"
---
# gt issue timeline
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Show the activity on an issue
## Synopsis
```text
Show what happened on an issue, oldest first: comments, and changes such as labels,
milestones, titles, assignees, references and state changes.
```
```
gt issue timeline {<number> | <url>} [flags]
```
## Examples
```
$ gt issue timeline 12
$ gt issue timeline 12 --json type,author,created_at
```
## Options
```
-h, --help help for timeline
-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 issue](../issue/index.md): Manage issues
cli-docs/reference/issue/view.md
-59
View File
@@ -1,59 +0,0 @@
---
sidebar_position: 9
description: "View an issue"
---
# gt issue view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View an issue
## Synopsis
```text
Display the title, body and other information about an issue. With --comments, the
conversation follows the body. The blocked_by and blocks JSON fields cost extra requests, made
only when the output includes them (see gt help formatting).
```
```
gt issue view {<number> | <url>} [flags]
```
## Examples
```
$ gt issue view 12
$ gt issue view 12 --comments
$ gt issue view https://gitea.com/OWNER/REPO/issues/12 --web
```
## Options
```
-c, --comments View issue comments
-h, --help help for view
-w, --web Open the issue in the browser
```
## 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 issue](../issue/index.md): Manage issues
cli-docs/reference/label/create.md
-64
View File
@@ -1,64 +0,0 @@
---
sidebar_position: 1
description: "Create a label"
---
# gt label create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create a label
## Synopsis
```text
Create a label. Without --color, the label gets a random color. A label with the same
name, ignoring case, is refused unless --force updates it. Without a name on a terminal,
prompts ask for the name, color and description.
```
```
gt label create <name> [flags]
```
## Examples
```
$ gt label create bug --color d73a4a --description "Something is broken"
$ gt label create "priority/high" --exclusive
# Update the label if it exists
$ gt label create bug -c ee0701 --force
```
## Options
```
--archived Archive the label so that it cannot be applied anymore
-c, --color digits Color as six hexadecimal digits, such as d73a4a
-d, --description string Description of the label
--exclusive Allow only one label of its scope, such as priority/high, per issue
-f, --force Update the label if one with the same name exists
-h, --help help for create
```
## 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
--org organization Manage the labels of an organization instead of a repository
--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 label](../label/index.md): Manage labels
cli-docs/reference/label/delete.md
-50
View File
@@ -1,50 +0,0 @@
---
sidebar_position: 2
description: "Delete labels"
---
# gt label delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete labels
```
gt label delete <label>... [flags]
```
## Examples
```
$ gt label delete bug
$ gt label delete wontfix duplicate --yes
```
## Options
```
--by-name Match numeric arguments as label names rather than IDs
-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
--org organization Manage the labels of an organization instead of a repository
--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 label](../label/index.md): Manage labels
cli-docs/reference/label/edit.md
-56
View File
@@ -1,56 +0,0 @@
---
sidebar_position: 3
description: "Edit a label"
---
# gt label edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit a label
```
gt label edit <label> [flags]
```
## Examples
```
$ gt label edit bug --name defect --color b60205
$ gt label edit "kind/question" --description "Further information is requested"
$ gt label edit old-stuff --archived
```
## Options
```
--archived Archive the label so that it cannot be applied anymore
--by-name Match a numeric argument as a label name rather than an ID
-c, --color digits Color as six hexadecimal digits, such as d73a4a
-d, --description string Description of the label
--exclusive Allow only one label of its scope, such as priority/high, per issue
-h, --help help for edit
-n, --name string Rename the label
```
## 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
--org organization Manage the labels of an organization instead of a repository
--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 label](../label/index.md): Manage labels
cli-docs/reference/label/export.md
-59
View File
@@ -1,59 +0,0 @@
---
sidebar_position: 4
description: "Export labels to a label file"
---
# gt label export
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Export labels to a label file
## Synopsis
```text
Write every label as a row of a label file, the format gt label import reads, to standard
output or to a new file.
```
```
gt label export [flags]
```
## Examples
```
$ gt label export > labels.txt
$ gt label export --org acme --output labels.txt
# Copy the labels of one repository to another
$ gt label export -R alice/old | gt label import - -R alice/new
```
## Options
```
-h, --help help for export
-O, --output file Write to a new file instead of standard output
```
## 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
--org organization Manage the labels of an organization instead of a repository
--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 label](../label/index.md): Manage labels
cli-docs/reference/label/import.md
-61
View File
@@ -1,61 +0,0 @@
---
sidebar_position: 5
description: "Create labels from a file"
---
# gt label import
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create labels from a file
## Synopsis
```text
Create the labels of a label file, one per line: "#color name", optionally followed by
" ;description" and then by the flags in one last field: " ;exclusive", " ;archived" or
" ;exclusive,archived". The description can be left out before the flags, as in
"#7057ff priority/high ;exclusive". gt label export writes this format, and Gitea's label
templates use it. Blank lines and lines starting with "# " or "##" are comments; any other
line must be a valid label. Existing labels are refused unless --force updates them.
```
```
gt label import <file> [flags]
```
## Examples
```
$ gt label import labels.txt
$ gt label export --repo alice/old | gt label import - --repo alice/new
```
## Options
```
-f, --force Update labels that exist already
-h, --help help for import
```
## 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
--org organization Manage the labels of an organization instead of a repository
--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 label](../label/index.md): Manage labels
cli-docs/reference/label/index.md
-55
View File
@@ -1,55 +0,0 @@
---
sidebar_position: 10
description: "Manage labels"
---
# gt label
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage labels
## Synopsis
```text
Work with the labels of a repository or, with --org, of an organization. Labels are
addressed by name or ID.
```
```
gt label [flags]
```
## Options
```
-h, --help help for label
--org organization Manage the labels of an organization instead of a repository
```
## 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 label create](../label/create.md): Create a label
* [gt label delete](../label/delete.md): Delete labels
* [gt label edit](../label/edit.md): Edit a label
* [gt label export](../label/export.md): Export labels to a label file
* [gt label import](../label/import.md): Create labels from a file
* [gt label list](../label/list.md): List labels
cli-docs/reference/label/list.md
-52
View File
@@ -1,52 +0,0 @@
---
sidebar_position: 6
description: "List labels"
---
# gt label list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List labels
```
gt label list [flags]
```
## Examples
```
$ gt label list
$ gt label list --org acme
$ gt label list --json name,color
```
## 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
--org organization Manage the labels of an organization instead of a repository
--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 label](../label/index.md): Manage labels
cli-docs/reference/milestone/close.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 1
description: "Close milestones"
---
# gt milestone close
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Close milestones
```
gt milestone close <milestone>... [flags]
```
## Examples
```
$ gt milestone close v1.0
$ gt milestone close v1.0 v1.1
```
## Options
```
--by-name Match numeric arguments as milestone titles rather than IDs
-h, --help help for close
```
## 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 milestone](../milestone/index.md): Manage milestones
cli-docs/reference/milestone/create.md
-65
View File
@@ -1,65 +0,0 @@
---
sidebar_position: 2
description: "Create a milestone"
---
# gt milestone create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create a milestone
## Synopsis
```text
Create a milestone. Without flags on a terminal, a form asks for the title, description
and due date. A milestone with the same title, ignoring case, is refused unless --force updates
it, since titles address milestones.
```
```
gt milestone create [<title>] [flags]
```
## Examples
```
$ gt milestone create v1.0 --deadline 2026-12-31 --description "First release"
$ gt milestone create --title v2.0 --editor
# Update the milestone if it exists
$ gt milestone create v1.0 --deadline 2027-01-31 --force
```
## Options
```
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC; with --force, empty clears the deadline of an existing milestone
-d, --description string Milestone description
-F, --description-file file Read the description from file, or - for stdin
-e, --editor Write the description in the configured editor
-f, --force Update the milestone if one with the same title exists
-h, --help help for create
--state string State of the new milestone {open|closed} (default "open")
-t, --title string Milestone title
```
## 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 milestone](../milestone/index.md): Manage milestones
cli-docs/reference/milestone/delete.md
-55
View File
@@ -1,55 +0,0 @@
---
sidebar_position: 3
description: "Delete a milestone"
---
# gt milestone delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete a milestone
## Synopsis
```text
Delete a milestone. Its issues and pull requests stay, without a milestone.
```
```
gt milestone delete <milestone> [flags]
```
## Examples
```
$ gt milestone delete v0.9
$ gt milestone delete 7 --yes
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
-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 milestone](../milestone/index.md): Manage milestones
cli-docs/reference/milestone/edit.md
-62
View File
@@ -1,62 +0,0 @@
---
sidebar_position: 4
description: "Edit a milestone"
---
# gt milestone edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit a milestone
## Synopsis
```text
Edit the title, description or due date of a milestone. Without flags on a terminal, a form
starts from the current values.
```
```
gt milestone edit <milestone> [flags]
```
## Examples
```
$ gt milestone edit v1.0 --title v1.0.0 --deadline 2027-01-31
$ gt milestone edit v1.0 --deadline=
$ gt milestone edit 3 --editor
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC; empty clears it
-d, --description string Milestone description
-F, --description-file file Read the description from file, or - for stdin
-e, --editor Write the description in the configured editor
-h, --help help for edit
-t, --title string Milestone title
```
## 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 milestone](../milestone/index.md): Manage milestones
cli-docs/reference/milestone/index.md
-56
View File
@@ -1,56 +0,0 @@
---
sidebar_position: 11
description: "Manage milestones"
---
# gt milestone
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage milestones
## Synopsis
```text
Work with the milestones of a repository and the issues and pull requests in them.
Milestones are addressed by title or ID.
```
```
gt milestone [flags]
```
## Options
```
-h, --help help for milestone
```
## 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 milestone close](../milestone/close.md): Close milestones
* [gt milestone create](../milestone/create.md): Create a milestone
* [gt milestone delete](../milestone/delete.md): Delete a milestone
* [gt milestone edit](../milestone/edit.md): Edit a milestone
* [gt milestone issue](../milestone/issue/index.md): Manage the issues and pull requests of a milestone
* [gt milestone list](../milestone/list.md): List milestones
* [gt milestone reopen](../milestone/reopen.md): Reopen milestones
* [gt milestone view](../milestone/view.md): View a milestone
cli-docs/reference/milestone/issue/add.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 1
description: "Add issues or pull requests to a milestone"
---
# gt milestone issue add
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Add issues or pull requests to a milestone
```
gt milestone issue add <milestone> {<number> | <url>}... [flags]
```
## Examples
```
$ gt milestone issue add v1.0 12
$ gt milestone issue add v1.0 12 13 '#14'
```
## Options
```
--by-name Match a numeric milestone argument as a title rather than an ID
-h, --help help for add
```
## 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 milestone issue](../../milestone/issue/index.md): Manage the issues and pull requests of a milestone
cli-docs/reference/milestone/issue/index.md
-51
View File
@@ -1,51 +0,0 @@
---
sidebar_position: 5
description: "Manage the issues and pull requests of a milestone"
---
# gt milestone issue
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage the issues and pull requests of a milestone
## Synopsis
```text
List the issues and pull requests in a milestone, or add them to it and remove them from
it. Milestones are addressed by title or ID; issues and pull requests by number or URL.
```
```
gt milestone issue [flags]
```
## Options
```
-h, --help help for issue
```
## 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 milestone](../../milestone/index.md): Manage milestones
* [gt milestone issue add](../../milestone/issue/add.md): Add issues or pull requests to a milestone
* [gt milestone issue list](../../milestone/issue/list.md): List issues and pull requests in a milestone
* [gt milestone issue remove](../../milestone/issue/remove.md): Remove issues or pull requests from a milestone
cli-docs/reference/milestone/issue/list.md
-53
View File
@@ -1,53 +0,0 @@
---
sidebar_position: 2
description: "List issues and pull requests in a milestone"
---
# gt milestone issue list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List issues and pull requests in a milestone
```
gt milestone issue list <milestone> [flags]
```
## Examples
```
$ gt milestone issue list v1.0
$ gt milestone issue list v1.0 --state all --kind issues
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
-h, --help help for list
--kind string List issues, pull requests or both; the kind field of each reads issue or pull {issues|pulls|all} (default "all")
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
-s, --state string Filter by state {open|closed|all} (default "open")
```
## 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 milestone issue](../../milestone/issue/index.md): Manage the issues and pull requests of a milestone
cli-docs/reference/milestone/issue/remove.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 3
description: "Remove issues or pull requests from a milestone"
---
# gt milestone issue remove
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Remove issues or pull requests from a milestone
```
gt milestone issue remove <milestone> {<number> | <url>}... [flags]
```
## Examples
```
$ gt milestone issue remove v1.0 12
$ gt milestone issue remove v1.0 12 13 '#14'
```
## Options
```
--by-name Match a numeric milestone argument as a title rather than an ID
-h, --help help for remove
```
## 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 milestone issue](../../milestone/issue/index.md): Manage the issues and pull requests of a milestone
cli-docs/reference/milestone/list.md
-57
View File
@@ -1,57 +0,0 @@
---
sidebar_position: 6
description: "List milestones"
---
# gt milestone list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List milestones
## Synopsis
```text
List the milestones of a repository: open ones first, then by due date.
```
```
gt milestone list [flags]
```
## Examples
```
$ gt milestone list
$ gt milestone list --state all --json title,due_on,open_issues,closed_issues
```
## Options
```
-h, --help help for list
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
-s, --state string Filter by state {open|closed|all} (default "open")
```
## 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 milestone](../milestone/index.md): Manage milestones
cli-docs/reference/milestone/reopen.md
-49
View File
@@ -1,49 +0,0 @@
---
sidebar_position: 7
description: "Reopen milestones"
---
# gt milestone reopen
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Reopen milestones
```
gt milestone reopen <milestone>... [flags]
```
## Examples
```
$ gt milestone reopen v1.0
$ gt milestone reopen v1.0 v1.1
```
## Options
```
--by-name Match numeric arguments as milestone titles rather than IDs
-h, --help help for reopen
```
## 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 milestone](../milestone/index.md): Manage milestones
cli-docs/reference/milestone/view.md
-50
View File
@@ -1,50 +0,0 @@
---
sidebar_position: 8
description: "View a milestone"
---
# gt milestone view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View a milestone
```
gt milestone view <milestone> [flags]
```
## Examples
```
$ gt milestone view v1.0
$ gt milestone view 3 --web
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
-h, --help help for view
-w, --web Open the milestone in the browser
```
## 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 milestone](../milestone/index.md): Manage milestones
cli-docs/reference/notification/index.md
-57
View File
@@ -1,57 +0,0 @@
---
sidebar_position: 12
description: "Read and triage your notifications"
---
# gt notification
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Read and triage your notifications
## Synopsis
```text
Read and triage the notifications of your account, across your whole inbox unless -R or
--this-repo selects a repository. IDs identify notification threads, not issue numbers. The
type of a notification is issue, pull, commit or repository, as --type selects them.
```
```
gt notification [flags]
```
## Options
```
-h, --help help for notification
--this-repo Only notifications of the repository in the current directory
```
## 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 notification list](../notification/list.md): List notifications
* [gt notification mark-read](../notification/mark-read.md): Mark notifications as read
* [gt notification mark-unread](../notification/mark-unread.md): Mark notifications as unread
* [gt notification pin](../notification/pin.md): Pin notifications
* [gt notification unpin](../notification/unpin.md): Unpin notifications
* [gt notification view](../notification/view.md): View a notification and mark it as read
* [gt notification watch](../notification/watch.md): Print notifications as they arrive
cli-docs/reference/notification/list.md
-58
View File
@@ -1,58 +0,0 @@
---
sidebar_position: 1
description: "List notifications"
---
# gt notification list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List notifications
```
gt notification list [flags]
```
## Examples
```
$ gt notification list
# Including the ones you read, of one repository
$ gt notification list --status unread,read,pinned -R alice/project
# Pull requests updated today
$ gt notification list --type pull --since 24h
```
## Options
```
--before string Only notifications updated before a date, timestamp, or duration such as 1h
-h, --help help for list
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
--since string Only notifications updated since a date, timestamp, or duration such as 24h
--status strings Only notifications with these statuses: unread, read, pinned (default [unread,pinned])
--type strings Only notifications about these subjects: issue, pull, commit, repository
```
## 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)
--this-repo Only notifications of the repository in the current directory
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
```
## SEE ALSO
* [gt notification](../notification/index.md): Read and triage your notifications
cli-docs/reference/notification/mark-read.md
-53
View File
@@ -1,53 +0,0 @@
---
sidebar_position: 2
description: "Mark notifications as read"
---
# gt notification mark-read
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Mark notifications as read
```
gt notification mark-read [<id>...] [flags]
```
## Examples
```
$ gt notification mark-read 28
# Everything in one repository
$ gt notification mark-read --all -R alice/project
```
## Options
```
--all Apply to every notification that matches --status in the scope
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
-h, --help help for mark-read
--status strings With --all, the statuses to change: unread, read, pinned
```
## 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)
--this-repo Only notifications of the repository in the current directory
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
```
## SEE ALSO
* [gt notification](../notification/index.md): Read and triage your notifications
cli-docs/reference/notification/mark-unread.md
-51
View File
@@ -1,51 +0,0 @@
---
sidebar_position: 3
description: "Mark notifications as unread"
---
# gt notification mark-unread
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Mark notifications as unread
```
gt notification mark-unread [<id>...] [flags]
```
## Examples
```
$ gt notification mark-unread 28 26
```
## Options
```
--all Apply to every notification that matches --status in the scope
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
-h, --help help for mark-unread
--status strings With --all, the statuses to change: unread, read, pinned
```
## 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)
--this-repo Only notifications of the repository in the current directory
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
```
## SEE ALSO
* [gt notification](../notification/index.md): Read and triage your notifications
cli-docs/reference/notification/pin.md
-51
View File
@@ -1,51 +0,0 @@
---
sidebar_position: 4
description: "Pin notifications"
---
# gt notification pin
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Pin notifications
```
gt notification pin [<id>...] [flags]
```
## Examples
```
$ gt notification pin 28
```
## Options
```
--all Apply to every notification that matches --status in the scope
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
-h, --help help for pin
--status strings With --all, the statuses to change: unread, read, pinned
```
## 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)
--this-repo Only notifications of the repository in the current directory
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
```
## SEE ALSO
* [gt notification](../notification/index.md): Read and triage your notifications
cli-docs/reference/notification/unpin.md
-53
View File
@@ -1,53 +0,0 @@
---
sidebar_position: 5
description: "Unpin notifications"
---
# gt notification unpin
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Unpin notifications
```
gt notification unpin [<id>...] [flags]
```
## Examples
```
$ gt notification unpin 28
# Unpin everything
$ gt notification unpin --all
```
## Options
```
--all Apply to every notification that matches --status in the scope
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
-h, --help help for unpin
--status strings With --all, the statuses to change: unread, read, pinned
```
## 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)
--this-repo Only notifications of the repository in the current directory
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
```
## SEE ALSO
* [gt notification](../notification/index.md): Read and triage your notifications
cli-docs/reference/notification/view.md
-57
View File
@@ -1,57 +0,0 @@
---
sidebar_position: 6
description: "View a notification and mark it as read"
---
# gt notification view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View a notification and mark it as read
## Synopsis
```text
View a notification: its subject, the subject's state and the latest comment. Like
opening it on the web, viewing marks an unread notification as read; pinned ones stay
pinned.
```
```
gt notification view <id> [flags]
```
## Examples
```
$ gt notification view 28
$ gt notification view 28 --json title,url
```
## Options
```
-h, --help help for view
```
## 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)
--this-repo Only notifications of the repository in the current directory
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
```
## SEE ALSO
* [gt notification](../notification/index.md): Read and triage your notifications
cli-docs/reference/notification/watch.md
-67
View File
@@ -1,67 +0,0 @@
---
sidebar_position: 7
description: "Print notifications as they arrive"
---
# gt notification watch
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Print notifications as they arrive
## Synopsis
```text
Print notifications as they arrive or change, until Ctrl-C or --timeout. On a terminal
it runs until stopped; otherwise it stops after a minute unless --timeout says otherwise.
With --json it prints one JSON object per line. It polls on through an outage of the instance
of up to 5 minutes.
```
```
gt notification watch [flags]
```
## Examples
```
$ gt notification watch
# Stream pull request notifications to a script, starting with the current ones
$ gt notification watch --type pull --json id,repository,title --timeout 0 | ./notify.sh
```
## Options
```
--before string Only notifications updated before a date, timestamp, or duration such as 1h
-h, --help help for watch
--interval duration Time between checks (default 5s)
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
--since string Only notifications updated since a date, timestamp, or duration such as 24h
--status strings Only notifications with these statuses: unread, read, pinned (default [unread,pinned])
--timeout duration Stop after this long (default: never on a terminal, 1m otherwise)
--type strings Only notifications about these subjects: issue, pull, commit, repository
```
## 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)
--this-repo Only notifications of the repository in the current directory
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
```
## SEE ALSO
* [gt notification](../notification/index.md): Read and triage your notifications
cli-docs/reference/org/create.md
-55
View File
@@ -1,55 +0,0 @@
---
sidebar_position: 1
description: "Create an organization"
---
# gt org create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create an organization
```
gt org create <name> [flags]
```
## Examples
```
$ gt org create acme --full-name "ACME Corp"
# create a private organization
$ gt org create acme-internal --visibility private
```
## Options
```
-d, --description string Organization description
--full-name string Display name
-h, --help help for create
--location string Location
--repo-admins-can-change-team-access Allow repository administrators to change team access (use =false to revoke)
--visibility string Who can see the organization {public|limited|private} (default "public")
--website string Website URL
```
## 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 org](../org/index.md): Manage organizations
cli-docs/reference/org/delete.md
-54
View File
@@ -1,54 +0,0 @@
---
sidebar_position: 2
description: "Delete an organization"
---
# gt org delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete an organization
## Synopsis
```text
Delete an organization with its teams. Gitea refuses while the organization owns repositories.
```
```
gt org delete <org> [flags]
```
## Examples
```
$ gt org delete acme-old
$ gt org delete acme-old --yes
```
## Options
```
-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 org](../org/index.md): Manage organizations
cli-docs/reference/org/edit.md
-54
View File
@@ -1,54 +0,0 @@
---
sidebar_position: 3
description: "Edit an organization"
---
# gt org edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit an organization
```
gt org edit <org> [flags]
```
## Examples
```
$ gt org edit acme --description "Tools for everyone" --website https://acme.example
$ gt org edit acme --visibility private
```
## Options
```
-d, --description string Organization description
--full-name string Display name
-h, --help help for edit
--location string Location
--repo-admins-can-change-team-access Allow repository administrators to change team access (use =false to revoke)
--visibility string Who can see the organization {public|limited|private}
--website string Website URL
```
## 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 org](../org/index.md): Manage organizations
cli-docs/reference/org/index.md
-56
View File
@@ -1,56 +0,0 @@
---
sidebar_position: 13
description: "Manage organizations"
---
# gt org
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage organizations
## Synopsis
```text
Work with Gitea organizations: list the ones you belong to, view, create, edit and delete
them, and manage their members.
Teams grant members access to an organization's repositories; see gt team.
```
```
gt org [flags]
```
## Options
```
-h, --help help for org
```
## 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 org create](../org/create.md): Create an organization
* [gt org delete](../org/delete.md): Delete an organization
* [gt org edit](../org/edit.md): Edit an organization
* [gt org list](../org/list.md): List organizations
* [gt org member](../org/member/index.md): Manage organization membership
* [gt org view](../org/view.md): View an organization
cli-docs/reference/org/list.md
-62
View File
@@ -1,62 +0,0 @@
---
sidebar_position: 4
description: "List organizations"
---
# gt org list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List organizations
## Synopsis
```text
List the organizations you belong to, those of another user, or every organization you can see.
```
```
gt org list [flags]
```
## Examples
```
# list your organizations
$ gt org list
# list the organizations of another user
$ gt org list --username bob
# list every organization on the instance
$ gt org list --all
```
## Options
```
--all List every organization you can see instead of your memberships
-h, --help help for list
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
--username string List the organizations of this user
```
## 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 org](../org/index.md): Manage organizations
cli-docs/reference/org/member/conceal.md
-53
View File
@@ -1,53 +0,0 @@
---
sidebar_position: 1
description: "Hide a membership"
---
# gt org member conceal
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Hide a membership
## Synopsis
```text
Make the membership of a user concealed. A public membership shows on the organization's profile.
```
```
gt org member conceal <org> <username> [flags]
```
## Examples
```
$ gt org member conceal acme bob
```
## Options
```
-h, --help help for conceal
```
## 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 org member](../../org/member/index.md): Manage organization membership
cli-docs/reference/org/member/index.md
-54
View File
@@ -1,54 +0,0 @@
---
sidebar_position: 5
description: "Manage organization membership"
---
# gt org member
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage organization membership
## Synopsis
```text
List the members of an organization, remove them, and choose whether a membership is public.
Gitea adds members through teams: add someone to an organization with
gt team member add ORG/TEAM USER.
```
```
gt org member [flags]
```
## Options
```
-h, --help help for member
```
## 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 org](../../org/index.md): Manage organizations
* [gt org member conceal](../../org/member/conceal.md): Hide a membership
* [gt org member list](../../org/member/list.md): List organization members
* [gt org member publicize](../../org/member/publicize.md): Make a membership public
* [gt org member remove](../../org/member/remove.md): Remove a member from an organization
cli-docs/reference/org/member/list.md
-62
View File
@@ -1,62 +0,0 @@
---
sidebar_position: 2
description: "List organization members"
---
# gt org member list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List organization members
## Synopsis
```text
List the members of an organization and whether each membership is public or concealed.
Gitea lists every membership as public to administrators, so for them gt checks the visibility
of each membership with one request per member. JSON output without the visibility field
skips those checks (see gt help formatting).
```
```
gt org member list <org> [flags]
```
## Examples
```
$ gt org member list acme
# list only the members everyone can see
$ gt org member list acme --public
```
## Options
```
-h, --help help for list
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
--public List only public memberships
```
## 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 org member](../../org/member/index.md): Manage organization membership
Loaded 100 of 264 files, more files were not shown because too many files have changed in this diff. Show more