Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List allowed values of gh config settings #8480

Open
muzimuzhi opened this issue Dec 20, 2023 · 1 comment
Open

List allowed values of gh config settings #8480

muzimuzhi opened this issue Dec 20, 2023 · 1 comment
Labels
enhancement a request to improve CLI gh-config relating to the gh config command help wanted Contributions welcome

Comments

@muzimuzhi
Copy link
Contributor

Describe the feature or problem you’d like to solve

In addition to default values, having allowed values documented would be more helpful and comprehensive.
https://cli.github.com/manual/gh_config
image

Related to

Proposed solution

Document allowed values.

Additional context

func ConfigOptions() []ConfigOption {
return []ConfigOption{
{
Key: gitProtocolKey,
Description: "the protocol to use for git clone and push operations",
DefaultValue: "https",
AllowedValues: []string{"https", "ssh"},
},
{
Key: editorKey,
Description: "the text editor program to use for authoring text",
DefaultValue: "",
},
{
Key: promptKey,
Description: "toggle interactive prompting in the terminal",
DefaultValue: "enabled",
AllowedValues: []string{"enabled", "disabled"},
},
{
Key: pagerKey,
Description: "the terminal pager program to send standard output to",
DefaultValue: "",
},
{
Key: httpUnixSocketKey,
Description: "the path to a Unix socket through which to make an HTTP connection",
DefaultValue: "",
},
{
Key: browserKey,
Description: "the web browser to use for opening URLs",
DefaultValue: "",
},
}
}

@muzimuzhi muzimuzhi added the enhancement a request to improve CLI label Dec 20, 2023
@cliAutomation cliAutomation added the needs-triage needs to be reviewed label Dec 20, 2023
@zsloane
Copy link
Contributor

zsloane commented Jan 11, 2024

My changes in #8395 address this.

I would like to make it more generic and have the docs package handle it but for now this incremental improvement should do

@samcoe samcoe added help wanted Contributions welcome gh-config relating to the gh config command and removed needs-triage needs to be reviewed labels Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to improve CLI gh-config relating to the gh config command help wanted Contributions welcome
Projects
None yet
Development

No branches or pull requests

4 participants