Affected by GO-2024-3269 and 3 other vulnerabilities

GO-2024-3269: Connecting to a malicious Codespaces via GH CLI could allow command execution on the user's computer in github.com/cli/cli

GO-2024-3296: Recursive repository cloning can leak authentication tokens to non-GitHub submodule hosts in github.com/cli/cli

GO-2024-3310: Downloading malicious GitHub Actions workflow artifact results in path traversal vulnerability in github.com/cli/cli

GO-2025-3467: `gh attestation verify` returns incorrect exit code during verification if no attestations are present in github.com/cli/cli

The highest tagged major version is v2.

cmdutil

package

v1.14.0 Latest Latest Go to latest Published: Aug 4, 2021 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cli/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AddJSONFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string)
func CheckAuth(cfg config.Config) bool
func DetermineEditor(cf func() (config.Config, error)) (string, error)
func DisableAuthCheck(cmd *cobra.Command)
func EnableRepoOverride(cmd *cobra.Command, f *Factory)
func ExactArgs(n int, msg string) cobra.PositionalArgs
func IsAuthCheckEnabled(cmd *cobra.Command) bool
func IsUserCancellation(err error) bool
func MinimumArgs(n int, msg string) cobra.PositionalArgs
func MutuallyExclusive(message string, conditions ...bool) error
func NoArgsQuoteReminder(cmd *cobra.Command, args []string) error
func OverrideBaseRepoFunc(f *Factory, override string) func() (ghrepo.Interface, error)
func ReadFile(filename string, stdin io.ReadCloser) ([]byte, error)
type Browser
- func NewBrowser(launcher string, stdout, stderr io.Writer) Browser
type Exporter
type Factory
type FlagError
- func (fe FlagError) Error() string
- func (fe FlagError) Unwrap() error
type JSONFlagError
type TestBrowser
- func (b *TestBrowser) Browse(url string) error
- func (b *TestBrowser) BrowsedURL() string
- func (b *TestBrowser) Verify(t _testing, url string)

Constants ¶

This section is empty.

Variables ¶

View Source

var CancelError = errors.New("CancelError")

CancelError signals user-initiated cancellation

View Source

var SilentError = errors.New("SilentError")

SilentError is an error that triggers exit code 1 without any error messaging

Functions ¶

func AddJSONFlags ¶ added in v1.9.0

func AddJSONFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string)

func CheckAuth ¶ added in v0.12.0

func CheckAuth(cfg config.Config) bool

func DetermineEditor ¶ added in v0.12.0

func DetermineEditor(cf func() (config.Config, error)) (string, error)

TODO: consider passing via Factory TODO: support per-hostname settings

func DisableAuthCheck ¶ added in v0.12.0

func DisableAuthCheck(cmd *cobra.Command)

func EnableRepoOverride ¶ added in v0.12.0

func EnableRepoOverride(cmd *cobra.Command, f *Factory)

func ExactArgs ¶ added in v1.7.0

func ExactArgs(n int, msg string) cobra.PositionalArgs

func IsAuthCheckEnabled ¶ added in v0.12.0

func IsAuthCheckEnabled(cmd *cobra.Command) bool

func IsUserCancellation ¶ added in v1.7.0

func IsUserCancellation(err error) bool

func MinimumArgs ¶ added in v1.2.1

func MinimumArgs(n int, msg string) cobra.PositionalArgs

func MutuallyExclusive ¶ added in v1.7.0

func MutuallyExclusive(message string, conditions ...bool) error

func NoArgsQuoteReminder ¶ added in v0.10.1

func NoArgsQuoteReminder(cmd *cobra.Command, args []string) error

func OverrideBaseRepoFunc ¶ added in v1.12.0

func OverrideBaseRepoFunc(f *Factory, override string) func() (ghrepo.Interface, error)

func ReadFile ¶ added in v1.7.0

func ReadFile(filename string, stdin io.ReadCloser) ([]byte, error)

Types ¶

type Browser ¶ added in v1.8.0

type Browser interface {
	Browse(string) error
}

func NewBrowser ¶ added in v1.8.0

func NewBrowser(launcher string, stdout, stderr io.Writer) Browser

type Exporter ¶ added in v1.9.0

type Exporter interface {
	Fields() []string
	Write(w io.Writer, data interface{}, colorEnabled bool) error
}

type Factory ¶

type Factory struct {
	IOStreams *iostreams.IOStreams
	Browser   Browser

	HttpClient func() (*http.Client, error)
	BaseRepo   func() (ghrepo.Interface, error)
	Remotes    func() (context.Remotes, error)
	Config     func() (config.Config, error)
	Branch     func() (string, error)

	ExtensionManager extensions.ExtensionManager

	// Executable is the path to the currently invoked gh binary
	Executable string
}

type FlagError ¶

type FlagError struct {
	Err error
}

FlagError is the kind of error raised in flag processing

func (FlagError) Error ¶

func (fe FlagError) Error() string

func (FlagError) Unwrap ¶

func (fe FlagError) Unwrap() error

type JSONFlagError ¶ added in v1.9.0

type JSONFlagError struct {
	// contains filtered or unexported fields
}

type TestBrowser ¶ added in v1.8.0

type TestBrowser struct {
	// contains filtered or unexported fields
}

func (*TestBrowser) Browse ¶ added in v1.8.0

func (b *TestBrowser) Browse(url string) error

func (*TestBrowser) BrowsedURL ¶ added in v1.8.0

func (b *TestBrowser) BrowsedURL() string

func (*TestBrowser) Verify ¶ added in v1.8.0

func (b *TestBrowser) Verify(t _testing, url string)

Source Files ¶

View all Source files

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