mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-08 11:00:34 +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,59 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
description: "Check gt's setup for this directory"
|
||||
---
|
||||
|
||||
# gt doctor
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Check gt's setup for this directory
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Check the setup that commands in this directory use: the settings files, the instance,
|
||||
its configured headers and whether it answers, the account and its credential, the
|
||||
repository, and Git. Each problem comes with the command that fixes it. gt doctor fails
|
||||
when a check fails.
|
||||
```
|
||||
|
||||
```
|
||||
gt doctor [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt doctor
|
||||
# Check another repository and instance
|
||||
$ gt doctor -R gitea.com/gitea/cli
|
||||
$ gt doctor --jq '.checks[] | select(.status == "failed")'
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for doctor
|
||||
```
|
||||
|
||||
## 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
|
||||
Reference in new issue
Block a user