command

package

v0.22.1 Latest Latest Go to latest Published: Aug 3, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Details

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

Repository

github.com/macropower/kat

Links

Open Source Insights

Documentation ¶

Overview ¶

Package command implements both rules and profiles, providing a single API for command execution, file watching, and event handling.

Index ¶

Variables
type Config
- func MustNewConfig(ps map[string]*profile.Profile, rs []*rule.Rule) *Config
- func NewConfig(ps map[string]*profile.Profile, rs []*rule.Rule) (*Config, error)
- func (c *Config) EnsureDefaults()
- func (c *Config) Validate() error
type Event
type EventCancel
type EventEnd
type EventStart
type Output
type Runner
- func NewRunner(path string, opts ...RunnerOpt) (*Runner, error)
type RunnerOpt
- func WithProfile(name string, p *profile.Profile) RunnerOpt
- func WithRules(rs []*rule.Rule) RunnerOpt
type Static
- func NewStatic(input string) (*Static, error)
type Type

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	DefaultConfig = MustNewConfig(defaultProfiles, defaultRules)
)

View Source

var ErrNoCommandForPath = errors.New("no command for path")

ErrNoCommandForPath is returned when no command is found for a path.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	// Profiles contains a map of profile names to profile configurations.
	Profiles map[string]*profile.Profile `json:"profiles,omitempty" jsonschema:"title=Profiles"`
	// Rules defines the rules for matching files to profiles.
	Rules []*rule.Rule `json:"rules,omitempty" jsonschema:"title=Rules"`
}

Config defines the core (non-UI) kat configuration.

func MustNewConfig ¶

func MustNewConfig(ps map[string]*profile.Profile, rs []*rule.Rule) *Config

func NewConfig ¶

func NewConfig(ps map[string]*profile.Profile, rs []*rule.Rule) (*Config, error)

func (*Config) EnsureDefaults ¶

func (c *Config) EnsureDefaults()

func (*Config) Validate ¶

func (c *Config) Validate() error

type Event ¶

type Event any

Event represents an event related to command execution.

type EventCancel ¶

type EventCancel struct{}

EventCancel indicates that a command execution has been canceled.

type EventEnd ¶

type EventEnd Output

EventEnd indicates that a command execution has ended. This event carries the output of the command execution, which could be an error if the command failed.

type EventStart ¶

type EventStart Type

EventStart indicates that a command execution has started.

type Output ¶

type Output struct {
	Error     error
	Stdout    string
	Stderr    string
	Resources []*kube.Resource
	Type      Type
}

type Runner ¶

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

Runner wraps one or more Rule objects. It manages:

File-to-command mappings.
Filesystem notifications / watching.
Concurrent command execution.

func (*Runner) Close ¶

func (cr *Runner) Close()

func (*Runner) GetCurrentProfile ¶

func (cr *Runner) GetCurrentProfile() *profile.Profile

func (*Runner) Run ¶

func (cr *Runner) Run() Output

RunFirstMatch executes the first matching command for the given path. If path is a file, it checks for direct matches. If path is a directory, it checks all files in the directory for matches.

func (*Runner) RunContext ¶

func (cr *Runner) RunContext(ctx context.Context) Output

RunContext executes the first matching command for the given path with the provided context. If path is a file, it checks for direct matches. If path is a directory, it checks all files in the directory for matches. The context can be used for cancellation, timeouts, and tracing.

func (*Runner) RunOnEvent ¶

func (cr *Runner) RunOnEvent()

RunOnEvent listens for file system events and runs the command in response. The output should be collected via Runner.Subscribe.

func (*Runner) RunPlugin ¶

func (cr *Runner) RunPlugin(name string) Output

RunPlugin executes a plugin by name.

func (*Runner) RunPluginContext ¶

func (cr *Runner) RunPluginContext(ctx context.Context, name string) Output

RunPluginContext executes a plugin by name with the provided context.

func (*Runner) SetExtraArgs ¶ added in v0.21.0

func (cr *Runner) SetExtraArgs(args []string) error

func (*Runner) String ¶

func (cr *Runner) String() string

func (cr *Runner) Subscribe(ch chan<- Event)

Subscribe allows other components to listen for command events.

func (*Runner) Watch ¶

func (cr *Runner) Watch() error

type RunnerOpt ¶

type RunnerOpt func(cr *Runner) error

func WithProfile ¶

func WithProfile(name string, p *profile.Profile) RunnerOpt

WithProfile sets a specific profile to use.

func WithRules ¶

func WithRules(rs []*rule.Rule) RunnerOpt

WithRules sets multiple rules from which the first matching rule will be used.

type Static ¶

type Static struct {
	Resources []*kube.Resource
	// contains filtered or unexported fields
}

func NewStatic ¶

func NewStatic(input string) (*Static, error)

func (*Static) Close ¶

func (rg *Static) Close()

func (*Static) GetCurrentProfile ¶

func (rg *Static) GetCurrentProfile() *profile.Profile

func (*Static) Run ¶

func (rg *Static) Run() Output

func (*Static) RunOnEvent ¶

func (rg *Static) RunOnEvent()

func (*Static) RunPlugin ¶

func (rg *Static) RunPlugin(_ string) Output

func (*Static) String ¶

func (rg *Static) String() string

func (rg *Static) Subscribe(ch chan<- Event)

type Type ¶

type Type int

const (
	// TypeRun indicates a command execution.
	TypeRun Type = iota
	// TypePlugin indicates a plugin execution.
	TypePlugin
)

Source Files ¶

View all Source files

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