commands

Documentation

Index

• type CredAlertCommand
• type ScanCommand
  • func (command *ScanCommand) Execute(args []string) error
• type UpdateCommand
  • func (command *UpdateCommand) Execute(args []string) error
• type VersionCommand
  • func (command *VersionCommand) Execute(args []string) error

Types

type CredAlertCommand

type CredAlertCommand struct {
	Scan    ScanCommand    `command:"scan" description:"Scan an archive, Git diff, or input from STDIN"`
	Update  UpdateCommand  `command:"update" description:"Update cred-alert to the latest version"`
	Version VersionCommand `command:"version" description:"Displays cred-alert version" alias:"V"`
}

var CredAlert CredAlertCommand

type ScanCommand

type ScanCommand struct {
	File            string `short:"f" long:"file" description:"the file or directory to scan" value-name:"FILE"`
	Diff            bool   `long:"diff" description:"content to be scanned is a git diff"`
	ShowCredentials bool   `long:"show-suspected-credentials" description:"allow credentials to be shown in output"`
	Regexp          string `long:"regexp" description:"override default regexp matcher" value-name:"REGEXP"`
	RegexpFile      string `long:"regexp-file" description:"path to regexp file" value-name:"PATH"`
}

func (*ScanCommand) Execute

func (command *ScanCommand) Execute(args []string) error

type UpdateCommand

type UpdateCommand struct{}

func (*UpdateCommand) Execute

func (command *UpdateCommand) Execute(args []string) error

type VersionCommand

type VersionCommand struct{}

func (*VersionCommand) Execute

func (command *VersionCommand) Execute(args []string) error