mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 01:50:30 +00:00
feat: generate the gt command reference from gitea/cli
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
This commit is contained in:
261 files changed
+15116
-2
No files matched your search
@@ -0,0 +1,55 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Make a membership public"
|
||||
---
|
||||
|
||||
# gt org member publicize
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Make a membership public
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Make the membership of a user public. A public membership shows on the organization's profile.
|
||||
```
|
||||
|
||||
```
|
||||
gt org member publicize <org> <username> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt org member publicize acme bob
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for publicize
|
||||
```
|
||||
|
||||
## 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
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Remove a member from an organization"
|
||||
---
|
||||
|
||||
# gt org member remove
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Remove a member from an organization
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Remove a user from an organization and from all of its teams.
|
||||
```
|
||||
|
||||
```
|
||||
gt org member remove <org> <username> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt org member remove acme bob
|
||||
```
|
||||
|
||||
## 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 org member](../../org/member/index.md): Manage organization membership
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "View an organization"
|
||||
---
|
||||
|
||||
# gt org view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View an organization
|
||||
|
||||
```
|
||||
gt org view <org> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt org view acme
|
||||
# print the description only
|
||||
$ gt org view acme --jq .description
|
||||
```
|
||||
|
||||
## 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 org](../org/index.md): Manage organizations
|
||||
Reference in new issue
Block a user