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,56 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Log time spent on an issue"
|
||||
---
|
||||
|
||||
# gt time create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Log time spent on an issue
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Log time spent on an issue or pull request. The duration uses h, m and s units, such as
|
||||
1h25m or "1h 25m".
|
||||
```
|
||||
|
||||
```
|
||||
gt time create {<number> | <url>} <duration> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt time create 12 1h25m
|
||||
$ gt time add 12 "1h 30m"
|
||||
$ gt time log https://gitea.com/OWNER/REPO/issues/12 45m
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-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 time](../time/index.md): Track time spent on issues and pull requests
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Delete a time record"
|
||||
---
|
||||
|
||||
# gt time delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete a time record
|
||||
|
||||
```
|
||||
gt time delete {<number> | <url>} <time-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Find the record with gt time list --issue 12
|
||||
$ gt time delete 12 8
|
||||
```
|
||||
|
||||
## 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 time](../time/index.md): Track time spent on issues and pull requests
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 24
|
||||
description: "Track time spent on issues and pull requests"
|
||||
---
|
||||
|
||||
# gt time
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Track time spent on issues and pull requests
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Log the time spent on issues and pull requests, list it for a repository, an issue or
|
||||
yourself across repositories, and delete it.
|
||||
```
|
||||
|
||||
```
|
||||
gt time [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for time
|
||||
```
|
||||
|
||||
## 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 time create](../time/create.md): Log time spent on an issue
|
||||
* [gt time delete](../time/delete.md): Delete a time record
|
||||
* [gt time list](../time/list.md): List tracked time
|
||||
* [gt time reset](../time/reset.md): Delete your time logged on an issue
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "List tracked time"
|
||||
---
|
||||
|
||||
# gt time list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List tracked time
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List the time tracked in a repository, on one issue with --issue, or by yourself across
|
||||
repositories with --mine. On a terminal, the total of the listed time follows the table.
|
||||
```
|
||||
|
||||
```
|
||||
gt time list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt time list
|
||||
$ gt time list --issue 12
|
||||
$ gt time list --mine --since 168h
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
--issue number List the time on one issue or pull request, by number or URL
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--mine List your time across repositories
|
||||
--page int Result page (default 1)
|
||||
--since string Only time tracked since a date, timestamp, or duration ago
|
||||
--total Print the total of the listed time also when piped
|
||||
--until string Only time tracked before a date, timestamp, or duration ago
|
||||
--username user List the time of one user; @me for yourself
|
||||
```
|
||||
|
||||
## 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 time](../time/index.md): Track time spent on issues and pull requests
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Delete your time logged on an issue"
|
||||
---
|
||||
|
||||
# gt time reset
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete your time logged on an issue
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Delete the time you logged on an issue or pull request. Gitea keeps the time other users logged.
|
||||
```
|
||||
|
||||
```
|
||||
gt time reset {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt time reset 12 --yes
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for reset
|
||||
```
|
||||
|
||||
## 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 time](../time/index.md): Track time spent on issues and pull requests
|
||||
Reference in new issue
Block a user