shared

package

v2.49.0 Latest Latest Go to latest Published: Apr 30, 2024 License: MIT Imports: 22 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cli/cli

Links

Open Source Insights

Documentation ¶

Index ¶

func AuthTokenWriteable(authCfg *config.AuthConfig, hostname string) (string, bool)
func GetCurrentLogin(httpClient httpClient, hostname, authToken string) (string, error)
func GetScopes(httpClient httpClient, hostname, authToken string) (string, error)
func HasMinimumScopes(httpClient httpClient, hostname, authToken string) error
func HeaderHasMinimumScopes(scopesHeader string) error
func Login(opts *LoginOptions) error
type GitCredentialFlow
type LoginOptions
type MissingScopesError
- func (e MissingScopesError) Error() string
type Prompt

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AuthTokenWriteable ¶ added in v2.14.0

func AuthTokenWriteable(authCfg *config.AuthConfig, hostname string) (string, bool)

func GetCurrentLogin ¶ added in v2.40.0

func GetCurrentLogin(httpClient httpClient, hostname, authToken string) (string, error)

func GetScopes ¶

func GetScopes(httpClient httpClient, hostname, authToken string) (string, error)

GetScopes performs a GitHub API request and returns the value of the X-Oauth-Scopes header.

func HasMinimumScopes ¶

func HasMinimumScopes(httpClient httpClient, hostname, authToken string) error

HasMinimumScopes performs a GitHub API request and returns an error if the token used in the request lacks the minimum required scopes for performing API operations with gh.

func HeaderHasMinimumScopes ¶ added in v2.22.0

func HeaderHasMinimumScopes(scopesHeader string) error

HeaderHasMinimumScopes parses the comma separated scopesHeader string and returns an error if it lacks the minimum required scopes for performing API operations with gh.

func Login(opts *LoginOptions) error

Types ¶

type GitCredentialFlow ¶

type GitCredentialFlow struct {
	Executable string
	Prompter   Prompt
	GitClient  *git.Client
	// contains filtered or unexported fields
}

func (*GitCredentialFlow) Prompt ¶

func (flow *GitCredentialFlow) Prompt(hostname string) error

func (*GitCredentialFlow) Scopes ¶

func (flow *GitCredentialFlow) Scopes() []string

func (*GitCredentialFlow) Setup ¶

func (flow *GitCredentialFlow) Setup(hostname, username, authToken string) error

func (*GitCredentialFlow) ShouldSetup ¶

func (flow *GitCredentialFlow) ShouldSetup() bool

type LoginOptions ¶

type LoginOptions struct {
	IO               *iostreams.IOStreams
	Config           iconfig
	HTTPClient       *http.Client
	GitClient        *git.Client
	Hostname         string
	Interactive      bool
	Web              bool
	Scopes           []string
	Executable       string
	GitProtocol      string
	Prompter         Prompt
	Browser          browser.Browser
	SecureStorage    bool
	SkipSSHKeyPrompt bool
	// contains filtered or unexported fields
}

type MissingScopesError ¶

type MissingScopesError struct {
	MissingScopes []string
}

func (MissingScopesError) Error ¶

func (e MissingScopesError) Error() string

type Prompt ¶ added in v2.16.0

type Prompt interface {
	Select(string, string, []string) (int, error)
	Confirm(string, bool) (bool, error)
	InputHostname() (string, error)
	AuthToken() (string, error)
	Input(string, string) (string, error)
	Password(string) (string, error)
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL