cli

Documentation

Index

• type CLI
  • func New(ted TokenRedacterUnredacter, execer Execer, opts ...NewOption) (*CLI, error)
  • func (c *CLI) Run(arguments []string) error
• type Config
• type Execer
• type NewOption
  • func Commit(v string) NewOption
  • func Date(v string) NewOption
  • func Version(v string) NewOption
• type TokenRedacterUnredacter

Types

type CLI

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

CLI provides a command-line interface for redactr

func New

func New(ted TokenRedacterUnredacter, execer Execer, opts ...NewOption) (*CLI, error)

New creates a new CLI

func (*CLI) Run

func (c *CLI) Run(arguments []string) error

Run runs the CLI

type Config

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

Config is used to configure a CLI

type Execer

type Execer interface {
	Exec(name string, args []string, opts ...redactr.ExecOption) error
}

An Execer can exec a shell command

type NewOption

type NewOption func(*Config)

A NewOption is used to alter a new CLI

func Commit

func Commit(v string) NewOption

Commit sets the commit of redactr, as reported by the CLI

func Date

func Date(v string) NewOption

Date sets the date of redactr, as reported by the CLI

func Version

func Version(v string) NewOption

Version sets the version of redactr, as reported by the CLI

type TokenRedacterUnredacter

type TokenRedacterUnredacter interface {
	RedactTokens(string) (string, error)
	UnredactTokens(string, ...redactr.UnredactTokensOption) (string, error)
}

A TokenRedacterUnredacter can redact and unredact tokens