cmd

Documentation

Index

• Constants
• func ColorOptions() []string
• func Execute()
• func GetVersion() string
• func GetVersionLean() string
• func InitColorPackage(colorWhen string) error
• func IsScorecardEnabled(when string) bool
• func IsScorecardVerbose(when string) bool
• func ValidateScorecardOption(opt string) error
• type Client
• type PolicyDoc

Constants

const (
	ArgErrorFile                = "error-file"
	ArgOutputFile               = "output-file"
	ArgPermissionsOutputFile    = "permissions-file"
	ArgToken                    = "token"
	ArgServerUrl                = "server-url"
	ArgIgnoreInvalidCertificate = "ignore-invalid-certificate"
	ScmType                     = "scm"
)

const (
	EnvToken     = "legitify_token"
	NewEnvToken  = "scm_token"
	EnvServerUrl = "server_url"
)

const (
	DefaultColorOption = colorAuto
)

const (
	DefaultScOption = scNo
)

Functions

func ColorOptions

func ColorOptions() []string

func Execute

func Execute()

func GetVersion

func GetVersion() string

func GetVersionLean

func GetVersionLean() string

func InitColorPackage

func InitColorPackage(colorWhen string) error

func IsScorecardEnabled

func IsScorecardEnabled(when string) bool

func IsScorecardVerbose

func IsScorecardVerbose(when string) bool

func ValidateScorecardOption

func ValidateScorecardOption(opt string) error

Types

type Client

type Client interface {
	IsAnalyzable(repo types.RepositoryWithOwner) (bool, error)
	Scopes() permissions.TokenScopes
	Organizations() ([]types.Organization, error)
	Repositories() ([]types.RepositoryWithOwner, error)
}

type PolicyDoc

type PolicyDoc struct {
	PolicyName  string `yaml:"policy_name"`
	Title       string
	Description string
	Severity    string
	Remediation []string
	Threat      []string
}