feat: generate the gt command reference from gitea/cli

update_cli_docs.sh runs gt's own generator and lays the pages out for the
site: one directory per command group, front matter, titles, sidebar
order, fenced help text and rewritten links. --released succeeds while no
series is documented. A weekly workflow proposes updates like the runner's.

Signed-off-by: bircni <[email protected]>
This commit is contained in:
bircni committed 2026-10-22 11:28:15 +02:00
1 parent fe618c42be
commit 55c3a392a1
261 files changed
+15116 -2

No files matched your search

+48
View File
@@ -0,0 +1,48 @@
---
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
+67
View File
@@ -0,0 +1,67 @@
---
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
+57
View File
@@ -0,0 +1,57 @@
---
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
+68
View File
@@ -0,0 +1,68 @@
---
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
+53
View File
@@ -0,0 +1,53 @@
---
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
+54
View File
@@ -0,0 +1,54 @@
---
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
+48
View File
@@ -0,0 +1,48 @@
---
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