mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +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,82 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Create a webhook"
|
||||
---
|
||||
|
||||
# gt webhook create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Create a webhook
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Create a webhook that delivers events to a URL, by default as JSON for push events.
|
||||
|
||||
Events: create, delete, fork, push, issues, issues_only, issue_assign, issue_label,
|
||||
issue_milestone, issue_comment, pull_request, pull_request_only, pull_request_assign,
|
||||
pull_request_label, pull_request_milestone, pull_request_comment, pull_request_review,
|
||||
pull_request_sync, pull_request_review_request, wiki, repository, release, package, status,
|
||||
workflow_run, workflow_job; issues and pull_request include every issue or pull request event.
|
||||
|
||||
Types: gitea, gogs, slack, discord, dingtalk, telegram, msteams, feishu, matrix, wechatwork,
|
||||
packagist. Slack webhooks need --config channel=#name (username, icon_url and color are
|
||||
optional). Gitea reads no other settings from --config, so set up discord, matrix and packagist
|
||||
webhooks in the web UI.
|
||||
```
|
||||
|
||||
```
|
||||
gt webhook create [<url>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt webhook create https://ci.example.com/hooks/gitea --events push,pull_request
|
||||
# sign deliveries with a secret read from a file
|
||||
$ gt webhook create https://ci.example.com/hooks/gitea --secret-file secret.txt
|
||||
# notify a Slack channel about releases of an organization's repositories
|
||||
$ gt webhook create https://hooks.slack.com/services/T0/B0/X --org acme --type slack --config channel=#releases --events release
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--active Deliver events (use --active=false to create the webhook paused) (default true)
|
||||
--authorization-header string Authorization value (prefer file input)
|
||||
--authorization-header-file string Read authorization value from file or -
|
||||
--branch-filter string Branch glob for push events
|
||||
--clear-authorization Send no authorization header; on edit, this removes the stored one
|
||||
--config stringToString Adapter-specific configuration, for example channel=alerts (default [])
|
||||
--events strings Events that trigger the webhook, comma-separated (default [push])
|
||||
-h, --help help for create
|
||||
--secret string Signing secret (prefer --secret-file)
|
||||
--secret-file string Read signing secret from file or -
|
||||
--type string Webhook adapter type {gitea|gogs|slack|discord|dingtalk|telegram|msteams|feishu|matrix|wechatwork|packagist} (default "gitea")
|
||||
--url string Delivery URL
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--account Manage the webhooks of your account
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--global Manage the system webhooks of the instance (administrators)
|
||||
--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 string Manage the webhooks of an organization
|
||||
--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 webhook](../webhook/index.md): Manage webhooks
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Delete a webhook"
|
||||
---
|
||||
|
||||
# gt webhook delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete a webhook
|
||||
|
||||
```
|
||||
gt webhook delete <id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt webhook delete 3
|
||||
$ gt webhook delete 4 --org acme --yes
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--account Manage the webhooks of your account
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--global Manage the system webhooks of the instance (administrators)
|
||||
--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 string Manage the webhooks of an organization
|
||||
--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 webhook](../webhook/index.md): Manage webhooks
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Edit a webhook"
|
||||
---
|
||||
|
||||
# gt webhook edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Edit a webhook
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Edit a webhook. Only the settings you pass change.
|
||||
|
||||
Gitea drops the stored authorization header of a webhook on every edit and never shows it, so
|
||||
pass it again with --authorization-header-file. On a terminal, gt asks for it instead; leave
|
||||
the answer empty for a webhook without one. Elsewhere, an edit without one of the
|
||||
authorization flags is refused before gt contacts Gitea. Signing secrets cannot be changed:
|
||||
recreate the webhook to rotate one.
|
||||
```
|
||||
|
||||
```
|
||||
gt webhook edit <id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# pause deliveries of a webhook without an authorization header
|
||||
$ gt webhook edit 3 --active=false --clear-authorization
|
||||
# keep the authorization header while changing the events
|
||||
$ gt webhook edit 3 --events push,release --authorization-header-file header.txt
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--active Deliver events, or pause the webhook with --active=false
|
||||
--authorization-header string Authorization value (prefer file input)
|
||||
--authorization-header-file string Read authorization value from file or -
|
||||
--branch-filter string Branch glob for push events
|
||||
--clear-authorization Send no authorization header; on edit, this removes the stored one
|
||||
--config stringToString Adapter-specific configuration, for example channel=alerts (default [])
|
||||
--events strings Events that trigger the webhook, comma-separated, replacing the current ones (see gt webhook create --help)
|
||||
-h, --help help for edit
|
||||
--url string Delivery URL
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--account Manage the webhooks of your account
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--global Manage the system webhooks of the instance (administrators)
|
||||
--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 string Manage the webhooks of an organization
|
||||
--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 webhook](../webhook/index.md): Manage webhooks
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 27
|
||||
description: "Manage webhooks"
|
||||
---
|
||||
|
||||
# gt webhook
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Manage webhooks
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Manage the webhooks of a repository, of an organization with --org, of your account with
|
||||
--account, or of the instance with --global (administrators). Without these flags, webhooks
|
||||
belong to the repository of the current directory or of --repo.
|
||||
|
||||
Delivery URLs often carry credentials, so gt shows them without user information and query,
|
||||
and without the path for chat services; gt webhook view --reveal-url shows a URL whole.
|
||||
Signing secrets and authorization headers are never shown.
|
||||
```
|
||||
|
||||
```
|
||||
gt webhook [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--account Manage the webhooks of your account
|
||||
--global Manage the system webhooks of the instance (administrators)
|
||||
-h, --help help for webhook
|
||||
--org string Manage the webhooks of an organization
|
||||
```
|
||||
|
||||
## 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 webhook create](../webhook/create.md): Create a webhook
|
||||
* [gt webhook delete](../webhook/delete.md): Delete a webhook
|
||||
* [gt webhook edit](../webhook/edit.md): Edit a webhook
|
||||
* [gt webhook list](../webhook/list.md): List webhooks
|
||||
* [gt webhook view](../webhook/view.md): View a webhook
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "List webhooks"
|
||||
---
|
||||
|
||||
# gt webhook list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List webhooks
|
||||
|
||||
```
|
||||
gt webhook list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt webhook list
|
||||
$ gt webhook list --org acme
|
||||
# print the delivery URLs
|
||||
$ gt webhook list --jq '.[].url'
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
```
|
||||
--account Manage the webhooks of your account
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--global Manage the system webhooks of the instance (administrators)
|
||||
--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 string Manage the webhooks of an organization
|
||||
--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 webhook](../webhook/index.md): Manage webhooks
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "View a webhook"
|
||||
---
|
||||
|
||||
# gt webhook view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a webhook
|
||||
|
||||
```
|
||||
gt webhook view <id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt webhook view 3
|
||||
# show the delivery URL with the credentials it carries
|
||||
$ gt webhook view 3 --org acme --reveal-url
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for view
|
||||
--reveal-url Show the delivery URL whole, with any credentials it carries
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--account Manage the webhooks of your account
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--global Manage the system webhooks of the instance (administrators)
|
||||
--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 string Manage the webhooks of an organization
|
||||
--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 webhook](../webhook/index.md): Manage webhooks
|
||||
Reference in new issue
Block a user