cli

package
v5.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2026 License: BSD-2-Clause Imports: 20 Imported by: 0

Documentation

Overview

Package cli provides the command-line interface for the teamvault utility.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Execute

func Execute()

Execute runs the CLI application. It sets up signal handling for SIGINT and SIGTERM, configures structured logging, and executes the root command. The sole context.Background() is created here and passed to Run.

func NewRootCommand

func NewRootCommand(ctx context.Context) *cobra.Command

NewRootCommand creates the root cobra command with all persistent flags and subcommands registered.

func ResetNewConnectorForTest added in v5.9.0

func ResetNewConnectorForTest()

ResetNewConnectorForTest is an alias for the reset function returned by SetNewConnectorForTest.

func ResetNewWriterForTest added in v5.8.0

func ResetNewWriterForTest()

ResetNewWriterForTest is an alias for the reset function returned by SetNewWriterForTest.

func Run

func Run(ctx context.Context, args []string) error

Run builds the root command and executes it with the given arguments. It returns any error from command execution.

func SetNewConnectorForTest added in v5.9.0

func SetNewConnectorForTest(
	f func(sf *SharedFlags) func(context.Context) (teamvault.Connector, error),
) func()

SetNewConnectorForTest overrides the connector constructor for tests. Returns a function to call in AfterEach to reset.

func SetNewWriterForTest added in v5.8.0

func SetNewWriterForTest(
	f func(sf *SharedFlags) func(context.Context) (teamvault.Writer, error),
) func()

SetNewWriterForTest overrides the writer constructor for tests. Returns a function to call in AfterEach to reset.

Types

type SharedFlags added in v5.8.0

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

SharedFlags holds the seven shared CLI flags that apply to all subcommands. Each flag falls back to its corresponding environment variable when not set.

Jump to

Keyboard shortcuts

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