mirror of
https://gitea.com/gitea/tea.git
synced 2026-10-26 19:11:25 +01:00
docs(config): describe every setting in config set --help
Signed-off-by: bircni <bircni@icloud.com>
This commit is contained in:
1 file changed
+16
@@ -255,6 +255,22 @@ $ tea config list --host https://gitea.com`,
|
|||||||
group.AddCommand(&cobra.Command{
|
group.AddCommand(&cobra.Command{
|
||||||
Use: "set <key> <value>", Short: "Change a setting", Args: argsExact(2), ValidArgsFunction: a.completeConfig,
|
Use: "set <key> <value>", Short: "Change a setting", Args: argsExact(2), ValidArgsFunction: a.completeConfig,
|
||||||
Annotations: textOutput("config set does not return a resource"),
|
Annotations: textOutput("config set does not return a resource"),
|
||||||
|
Long: `Change a preference, an instance setting (--host) or an account setting (--host and --user).
|
||||||
|
|
||||||
|
Preferences:
|
||||||
|
default_host instance to use when no flag or repository selects one
|
||||||
|
git_protocol https or ssh, for clones and remotes
|
||||||
|
editor command that edits bodies and messages, such as "code --wait"
|
||||||
|
prompt enabled or disabled; disabled turns prompts off
|
||||||
|
pager command that pages long output on a terminal; TEA_PAGER overrides it
|
||||||
|
browser command that opens URLs; never disables opening
|
||||||
|
color auto, always or never
|
||||||
|
hyperlinks auto, always or never, for clickable links in terminals
|
||||||
|
markdown auto renders Markdown on a terminal, raw prints the source
|
||||||
|
remote Git remote used to find the repository of a clone
|
||||||
|
|
||||||
|
Instance settings: user (active account), ssh_host, insecure, git_protocol, oauth_client_id.
|
||||||
|
Account settings: ssh_key, ssh_agent, ssh_certificate_principal, ssh_key_fingerprint.`,
|
||||||
Example: `$ tea config set editor "code --wait"
|
Example: `$ tea config set editor "code --wait"
|
||||||
$ tea config set ssh_host git.example.com:2222 --host https://example.com
|
$ tea config set ssh_host git.example.com:2222 --host https://example.com
|
||||||
$ tea config set ssh_key ~/.ssh/id_ed25519 --host https://example.com --user alice`,
|
$ tea config set ssh_key ~/.ssh/id_ed25519 --host https://example.com --user alice`,
|
||||||
|
|||||||
Reference in new issue
Block a user