Struct gh_config::Config

pub struct Config {
    pub git_protocol: GitProtocol,
    pub editor: Option<String>,
    pub prompt: Prompt,
    pub pager: Option<String>,
    pub aliases: HashMap<String, String>,
    pub http_unix_socket: Option<String>,
    pub browser: Option<String>,
}

Config representation for gh CLI.

Fields

git_protocol: GitProtocol

What protocol to use when performing git operations.

editor: Option<String>

What editor gh should run when creating issues, pull requests, etc. If blank, will refer to environment.

prompt: Prompt

When to interactively prompt. This is a global config that cannot be overridden by hostname.

pager: Option<String>

A pager program to send command output to, e.g. “less”. Set the value to “cat” to disable the pager.

aliases: HashMap<String, String>

Aliases allow you to create nicknames for gh commands.

http_unix_socket: Option<String>

The path to a unix socket through which send HTTP connections. If blank, HTTP traffic will be handled by default transport.

browser: Option<String>

What web browser gh should use when opening URLs. If blank, will refer to environment.

Implementations

impl Config

pub fn load() -> Result<Self, Error>

Loads a config from the default path.

pub fn load_from<P>(path: P) -> Result<Self, Error> where
    P: AsRef<Path>, 

Loads all host configs from the specified path.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.