cmd

Documentation

Index

• Constants
• Variables
• func CalculateEnvVarName(key string) string
• func Execute(rootCmd *cobra.Command) error
• func LogColorDisabled() bool
• func NewGateError(policyName string) error
• func NewRootCmd(l zerolog.Logger) *cobra.Command
• func NewVersionCmd() *cobra.Command
• func ParseAndValidateOpts(opts []string, schema *action.JSONSchema) (map[string]any, error)
• func ParseKeyValOpts(opts []string, propertiesMap sdk.SchemaPropertiesMap) (map[string]any, error)
• func RenderSchemaRaw(tableTitle string, s string) error
• func RenderSchemaTable(tableTitle string, properties sdk.SchemaPropertiesMap) error
• func WorkflowListTableOutput(workflowListResult *action.WorkflowListResult) error
• type DotChainloopConfig
• type GateError
  • func (e *GateError) Error() string
• type GracefulError
  • func (e GracefulError) Error() string
  • func (e GracefulError) Unwrap() error

Constants

const NotSet = "[NOT SET]"

const UserWithNoOrganizationMsg = "you are not part of any organization, please run \"chainloop organization create --name ORG_NAME\" to create one"

Variables

var (
	Version = devVersion
	Edition = ossEdition
)

var (
	ActionOpts *action.ActionsOpts
)

var ErrAttestationAlreadyExist = errors.New("attestation already initialized, to override it use the --replace flag`")

var ErrAttestationNotInitialized = errors.New("attestation not yet initialized, execute the init command first")

var ErrAttestationTokenRequired = errors.New("chainloop Token required, please provide it via --token flag or CHAINLOOP_TOKEN environment variable")

var ErrKeylessNotSupported = errors.New("keyless signing not supported, please provide a private key reference with --key instead")

var (
	GracefulExit bool
)

Functions

func CalculateEnvVarName

func CalculateEnvVarName(key string) string

this could have been done using automatic + prefix but we want to have control and know the values

viper.AutomaticEnv()
viper.SetEnvPrefix(envPrefix)
viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_", ".", "_"))

func Execute

func Execute(rootCmd *cobra.Command) error

func LogColorDisabled

func LogColorDisabled() bool

LogColorDisabled reports whether colorized log output should be disabled. It follows the same approach as the supports-color/chalk family: honor the NO_COLOR / FORCE_COLOR conventions, then enable color on an interactive terminal or in a CI system known to render ANSI escape codes.

func NewGateError

func NewGateError(policyName string) error

func NewRootCmd

func NewRootCmd(l zerolog.Logger) *cobra.Command

func NewVersionCmd

func NewVersionCmd() *cobra.Command

func ParseAndValidateOpts

func ParseAndValidateOpts(opts []string, schema *action.JSONSchema) (map[string]any, error)

func ParseKeyValOpts

func ParseKeyValOpts(opts []string, propertiesMap sdk.SchemaPropertiesMap) (map[string]any, error)

ParseKeyValOpts performs two steps 1 - Split the options into key/value pairs 2 - Cast the values to the expected type defined in the schema

func RenderSchemaRaw

func RenderSchemaRaw(tableTitle string, s string) error

render raw JSON schema document

func RenderSchemaTable

func RenderSchemaTable(tableTitle string, properties sdk.SchemaPropertiesMap) error

render de-normalized schema format

func WorkflowListTableOutput

func WorkflowListTableOutput(workflowListResult *action.WorkflowListResult) error

Types

type DotChainloopConfig

type DotChainloopConfig struct {
	ProjectVersion string `yaml:"projectVersion"`
}

type GateError

type GateError struct {
	PolicyName string
}

func (*GateError) Error

func (e *GateError) Error() string

type GracefulError

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

GracefulError represents an error that has been marked as gracefully handled In some parts of our code, we want to raise errors but we don't want the CLI to fail because of the flakiness or active development of the tool

func (GracefulError) Error

func (e GracefulError) Error() string

func (GracefulError) Unwrap

func (e GracefulError) Unwrap() error