cli

Documentation

Index

• Constants
• func NewRootCommand() *cobra.Command
• type DocDrift
  • func (d DocDrift) Pretty() string
• type FileDiff

Constants

const EnvCredentialPassphrase = "SSHQ_CREDENTIAL_PASSPHRASE"

EnvCredentialPassphrase supplies the passphrase for a passphrase-mode credential store in non-interactive runtime contexts (daemon background loop, agent pipe). Direct commands fall back to a TTY prompt when it is unset.

Functions

func NewRootCommand

func NewRootCommand() *cobra.Command

Types

type DocDrift

type DocDrift struct {
	Consistent bool       `json:"consistent"`
	Added      []string   `json:"added,omitempty"`
	Removed    []string   `json:"removed,omitempty"`
	Changed    []FileDiff `json:"changed,omitempty"`
}

DocDrift holds the result of comparing generated docs against existing ones.

func (DocDrift) Pretty

func (d DocDrift) Pretty() string

type FileDiff

type FileDiff struct {
	File    string `json:"file"`
	Summary string `json:"summary"`
}