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

+65
View File
@@ -0,0 +1,65 @@
---
sidebar_position: 1
description: "Create a team"
---
# gt team create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create a team
## Synopsis
```text
Create a team in an organization. Name it as the second argument, as ORG/NAME, or with --name.
--permission grants read or write access to every repository unit, or admin access. Use --unit
to set single units instead, or to override some of them.
```
```
gt team create <org> [<name>] [flags]
```
## Examples
```
$ gt team create acme developers --permission write
$ gt team create acme/reviewers --unit repo.code=read,repo.pulls=write
# give the team access to every repository of the organization
$ gt team create acme ops --permission admin --all-repositories
```
## Options
```
--all-repositories Access every organization repository (use =false to revoke)
--can-create-repo Allow creating organization repositories (use =false to revoke)
-d, --description string Team description
-h, --help help for create
--name string Team name
--permission string Access to every repository unit; admin also manages repositories {read|write|admin} (default "read")
--unit stringToString Unit access, such as repo.code=write,repo.wiki=read; overrides --permission per unit (default [])
```
## 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 team](../team/index.md): Manage organization teams and access
+55
View File
@@ -0,0 +1,55 @@
---
sidebar_position: 2
description: "Delete a team"
---
# gt team delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete a team
## Synopsis
```text
Delete a team. Deleting an organization's owner team needs --force.
```
```
gt team delete <team> [flags]
```
## Examples
```
$ gt team delete acme/reviewers
$ gt team delete 7 --yes
```
## Options
```
--force Allow deleting the organization's owner team
-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 team](../team/index.md): Manage organization teams and access
+65
View File
@@ -0,0 +1,65 @@
---
sidebar_position: 3
description: "Edit a team"
---
# gt team edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit a team
## Synopsis
```text
Edit a team. --permission sets every repository unit to read or write, or grants admin
access. --unit changes single units and keeps the others, unless --unit-replace is passed.
Only the description of an organization's owner team can be edited.
```
```
gt team edit <team> [flags]
```
## Examples
```
$ gt team edit acme/developers --permission write
# also let the team edit the wiki
$ gt team edit acme/developers --unit repo.wiki=write
$ gt team edit acme/developers --name devs --description "Core developers"
```
## Options
```
--all-repositories Access every organization repository (use =false to revoke)
--can-create-repo Allow creating organization repositories (use =false to revoke)
-d, --description string Team description
-h, --help help for edit
--name string Team name
--permission string Access to every repository unit; admin also manages repositories {read|write|admin}
--unit stringToString Unit access to change, such as repo.wiki=write; merged into the current policy (default [])
--unit-replace Replace the whole unit policy with --unit; omitted units lose access
```
## 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 team](../team/index.md): Manage organization teams and access
+59
View File
@@ -0,0 +1,59 @@
---
sidebar_position: 23
description: "Manage organization teams and access"
---
# gt team
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage organization teams and access
## Synopsis
```text
Manage the teams of an organization: what they may do in its repositories, who belongs to
them, and which repositories they can reach.
In JSON, access is the team's effective access as the text views show it, such as write or
"write (code, issues, pulls)"; permission is the team-wide level Gitea reports, which is none
for a team that grants its access per unit.
```
```
gt team [flags]
```
## Options
```
-h, --help help for team
```
## 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 team create](../team/create.md): Create a team
* [gt team delete](../team/delete.md): Delete a team
* [gt team edit](../team/edit.md): Edit a team
* [gt team list](../team/list.md): List organization teams
* [gt team member](../team/member/index.md): Manage team members
* [gt team repo](../team/repo/index.md): Manage team repository access
* [gt team view](../team/view.md): View a team
+59
View File
@@ -0,0 +1,59 @@
---
sidebar_position: 4
description: "List organization teams"
---
# gt team list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List organization teams
## Synopsis
```text
List the teams of an organization with their access to its repositories and, when the page
holds at most 10 teams, their member and repository counts. Gitea reports no counts with the
teams, so each team costs two more requests; gt team view shows the counts of one team.
```
```
gt team list <org> [flags]
```
## Examples
```
$ gt team list acme
# print the team names
$ gt team list acme --jq '.[].name'
```
## 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 team](../team/index.md): Manage organization teams and access
+48
View File
@@ -0,0 +1,48 @@
---
sidebar_position: 1
description: "Add users to a team"
---
# gt team member add
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Add users to a team
```
gt team member add <team> <username>... [flags]
```
## Examples
```
$ gt team member add acme/developers bob
$ gt team member add 2 bob carol
```
## Options
```
-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 team member](../../team/member/index.md): Manage team members
+51
View File
@@ -0,0 +1,51 @@
---
sidebar_position: 5
description: "Manage team members"
---
# gt team member
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage team members
## Synopsis
```text
List, add and remove the members of a team. Adding a user to a team of an organization
also makes them a member of the organization.
```
```
gt team 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 team](../../team/index.md): Manage organization teams and access
* [gt team member add](../../team/member/add.md): Add users to a team
* [gt team member list](../../team/member/list.md): List team members
* [gt team member remove](../../team/member/remove.md): Remove users from a team
+49
View File
@@ -0,0 +1,49 @@
---
sidebar_position: 2
description: "List team members"
---
# gt team member list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List team members
```
gt team member list <team> [flags]
```
## Examples
```
$ gt team member list acme/developers
```
## 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 team member](../../team/member/index.md): Manage team members
+47
View File
@@ -0,0 +1,47 @@
---
sidebar_position: 3
description: "Remove users from a team"
---
# gt team member remove
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Remove users from a team
```
gt team member remove <team> <username>... [flags]
```
## Examples
```
$ gt team member remove acme/developers carol
```
## Options
```
-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 team member](../../team/member/index.md): Manage team members
+55
View File
@@ -0,0 +1,55 @@
---
sidebar_position: 1
description: "Grant a team access to repositories"
---
# gt team repo add
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Grant a team access to repositories
## Synopsis
```text
Grant a team access to repositories of its organization. Name the repositories alone, such as service, or as ORG/NAME;
repositories of other owners cannot be granted to a team.
```
```
gt team repo add <team> <repository>... [flags]
```
## Examples
```
$ gt team repo add acme/developers service
$ gt team repo add 2 acme/service acme/website
```
## Options
```
-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 team repo](../../team/repo/index.md): Manage team repository access
+51
View File
@@ -0,0 +1,51 @@
---
sidebar_position: 6
description: "Manage team repository access"
---
# gt team repo
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage team repository access
## Synopsis
```text
List the repositories a team can reach, and grant or revoke its access to repositories of
its organization. Repositories are named alone, such as service, or as ORG/NAME.
```
```
gt team repo [flags]
```
## Options
```
-h, --help help for repo
```
## 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 team](../../team/index.md): Manage organization teams and access
* [gt team repo add](../../team/repo/add.md): Grant a team access to repositories
* [gt team repo list](../../team/repo/list.md): List team repositories
* [gt team repo remove](../../team/repo/remove.md): Revoke team access to repositories
+49
View File
@@ -0,0 +1,49 @@
---
sidebar_position: 2
description: "List team repositories"
---
# gt team repo list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List team repositories
```
gt team repo list <team> [flags]
```
## Examples
```
$ gt team repo list acme/developers
```
## 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 team repo](../../team/repo/index.md): Manage team repository access
+54
View File
@@ -0,0 +1,54 @@
---
sidebar_position: 3
description: "Revoke team access to repositories"
---
# gt team repo remove
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Revoke team access to repositories
## Synopsis
```text
Revoke team access to repositories of its organization. Name the repositories alone, such as service, or as ORG/NAME;
repositories of other owners cannot be granted to a team.
```
```
gt team repo remove <team> <repository>... [flags]
```
## Examples
```
$ gt team repo remove acme/developers legacy
```
## Options
```
-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 team repo](../../team/repo/index.md): Manage team repository access
+54
View File
@@ -0,0 +1,54 @@
---
sidebar_position: 7
description: "View a team"
---
# gt team view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View a team
## Synopsis
```text
View a team: its access to each repository unit, its members and its repositories.
```
```
gt team view <team> [flags]
```
## Examples
```
$ gt team view acme/developers
$ gt team view 2 --json units
```
## 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 team](../team/index.md): Manage organization teams and access