cli

Documentation

Overview

Package cli assembles the Draugr command-line interface on top of Cobra.

Index

• Constants
• func Execute(ctx context.Context) int
• func IsFragmentFile(name string) bool
• func LogWriter(w io.Writer) io.Writer
• func ZeroConfigControls(conjunction string) string

Constants

const DescriptorName = "draugr.saga.yaml"

DescriptorName is the file `draugr init` writes. It is one of several names a scan will find, not the only one — see descriptorsIn.

Functions

func Execute

func Execute(ctx context.Context) int

Execute builds and runs the root command using the process arguments, wiring telemetry and interrupt handling around it. It returns a process exit code.

func IsFragmentFile

func IsFragmentFile(name string) bool

IsFragmentFile reports whether a filename is a Saga fragment.

A distinct file type rather than a convention, because editors decide which schema to apply from the name: the Saga schema requires a release, so a fragment named `*.saga.yaml` would be flagged as invalid in every editor that reads the published catalogue.

func LogWriter

func LogWriter(w io.Writer) io.Writer

LogWriter wraps stderr so a log line erases the progress line before printing.

The erase and the write happen under the renderer's own lock, so an update cannot redraw between them and leave the two interleaved.

func ZeroConfigControls

func ZeroConfigControls(conjunction string) string

ZeroConfigControls lists those controls in a readable form, e.g. "sca, secrets, sast, and iac".