Update CLI usage guide, add project lookup guide

There's a new inconsistency, however. The previous URL and FQRN
arguments are no longer mandatory but their description makes it seem
as though they are.
This commit is contained in:
2025-07-21 14:01:06 -05:00
parent fc0d1b569c
commit 1a619d7bb4

View File

@@ -5,7 +5,7 @@ CLI tools for interacting with the Gitea API. Use interactively to talk to your
## Usage ## Usage
```txt ```txt
Usage: gt-tools --url <GITEA_URL> --repo <REPO> <COMMAND> Usage: gt-tool [OPTIONS] <COMMAND>
Commands: Commands:
list-releases list-releases
@@ -14,10 +14,11 @@ Commands:
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
Options: Options:
-u, --url <GITEA_URL> [env: GTTOOL_GITEA_URL=] -u, --url <GITEA_URL> [env: GTTOOL_GITEA_URL=]
-r, --repo <REPO> [env: GTTOOL_FQRN=] -r, --repo <REPO> [env: GTTOOL_FQRN=]
-h, --help Print help -p, --project <PROJECT> Path to project (relative or absolute). Used to select configuration.
-V, --version Print version -h, --help Print help
-V, --version Print version
``` ```
### Authentication ### Authentication
@@ -40,6 +41,12 @@ The repository name must be provided with `--repo` or `-u` on the command line,
E.g.: `--repo "go-gitea/gitea"` would name the Gitea repo belonging to the go-gitea organization. E.g.: `--repo "go-gitea/gitea"` would name the Gitea repo belonging to the go-gitea organization.
### `<PROJECT>`
Override the default (current-directory) project name when searching through the config files for this project's settings.
See [configuration](#configuration) for details on format and file locations.
### `<COMMAND>`: ### `<COMMAND>`:
One of these, defaults to `help`: One of these, defaults to `help`: