Documentation
¶
Index ¶
- Constants
- Variables
- func CalculateEnvVarName(key string) string
- func Execute(rootCmd *cobra.Command) error
- func InitHookLogger() func()
- func LogColorDisabled() bool
- func Logger() zerolog.Logger
- 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
- type GracefulError
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 ¶ added in v1.45.4
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 InitHookLogger ¶ added in v1.108.0
func InitHookLogger() func()
InitHookLogger reconfigures the root logger for git/agent hook commands: colorless output, all levels written to the trace state's log.txt, and Warn+ (or Debug, with --debug) written to stderr. Colorless matters because the hook's output is interleaved with git's during a commit or push, and main reads the same logger for its final error line.
If trace state cannot be located or the file cannot be opened, the logger falls back to colorless stderr-only output so the rest of the hook still runs with consistent formatting. Returns a cleanup function that closes the log file — callers should defer it at the top of a hook's RunE.
func LogColorDisabled ¶ added in v1.101.0
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 Logger ¶ added in v1.108.0
Logger returns the root logger. Hook commands swap it in place (see InitHookLogger), and main reads it for its final error line so that line shares the hook's colorless formatting during a git commit or push.
func NewGateError ¶ added in v1.64.0
func NewVersionCmd ¶
func ParseAndValidateOpts ¶ added in v1.76.0
func ParseKeyValOpts ¶ added in v1.76.0
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 ¶ added in v1.76.0
render raw JSON schema document
func RenderSchemaTable ¶ added in v1.76.0
func RenderSchemaTable(tableTitle string, properties sdk.SchemaPropertiesMap) error
render de-normalized schema format
func WorkflowListTableOutput ¶
func WorkflowListTableOutput(workflowListResult *action.WorkflowListResult) error
Types ¶
type DotChainloopConfig ¶ added in v0.97.7
type DotChainloopConfig struct {
ProjectVersion string `yaml:"projectVersion"`
}
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 ¶ added in v0.96.5
func (e GracefulError) Unwrap() error
Source Files
¶
- apply.go
- artifact.go
- artifact_download.go
- artifact_upload.go
- attached_integration.go
- attached_integration_add.go
- attached_integration_delete.go
- attached_integration_list.go
- attestation.go
- attestation_add.go
- attestation_init.go
- attestation_push.go
- attestation_reset.go
- attestation_status.go
- attestation_verify.go
- auth.go
- auth_delete_account.go
- auth_login.go
- available_integration.go
- available_integration_describe.go
- available_integration_list.go
- casbackend.go
- casbackend_add_azureblob.go
- casbackend_add_oci.go
- casbackend_add_s3.go
- casbackend_delete.go
- casbackend_list.go
- casbackend_update_azureblob.go
- casbackend_update_inline.go
- casbackend_update_oci.go
- casbackend_update_s3.go
- color.go
- config.go
- config_reset.go
- config_save.go
- config_view.go
- errors.go
- integration.go
- organization.go
- organization_apitoken.go
- organization_apitoken_create.go
- organization_apitoken_list.go
- organization_apitoken_revoke.go
- organization_create.go
- organization_delete.go
- organization_describe.go
- organization_invitation.go
- organization_invitation_create.go
- organization_invitation_list_sent.go
- organization_invitation_revoke.go
- organization_leave.go
- organization_list.go
- organization_member.go
- organization_member_delete.go
- organization_member_list.go
- organization_member_update.go
- organization_set.go
- organization_update.go
- plugins.go
- policy.go
- policy_develop.go
- policy_develop_eval.go
- policy_develop_init.go
- policy_develop_lint.go
- referrer_discover.go
- registered_integration.go
- registered_integration_add.go
- registered_integration_delete.go
- registered_integration_list.go
- root.go
- terminalunix.go
- trace.go
- trace_hook.go
- trace_hooklog.go
- trace_init.go
- trace_run.go
- trace_uninstall.go
- version.go
- workflow.go
- workflow_contract.go
- workflow_contract_apply.go
- workflow_contract_create.go
- workflow_contract_delete.go
- workflow_contract_describe.go
- workflow_contract_list.go
- workflow_contract_update.go
- workflow_create.go
- workflow_delete.go
- workflow_describe.go
- workflow_list.go
- workflow_update.go
- workflow_workflow_run.go
- workflow_workflow_run_describe.go
- workflow_workflow_run_list.go
Directories