Documentation
¶
Overview ¶
Package commands provides the command-line interface for suve.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var App = MakeApp()
App is the main CLI application.
View Source
var Version = "dev"
Version is set by goreleaser via ldflags.
Functions ¶
func IsShellCompletion ¶ added in v1.9.0
IsShellCompletion reports whether args contain the hidden --generate-shell-completion flag that urfave/cli passes on every shell TAB.
func MakeApp ¶
MakeApp creates a new CLI application instance, resolving the flat `param` / `secret` aliases from the current environment.
func MakeAppWithDetect ¶ added in v0.8.0
MakeAppWithDetect builds the app with an explicit provider-detection result. It is the injectable seam behind MakeApp: production passes the env-resolved result, while tests (and any caller needing determinism) pass a fixed one.
func RegisterTUIDescription ¶ added in v1.9.0
func RegisterTUIDescription()
RegisterTUIDescription rewrites the root usage to advertise the TUI. It must run BEFORE registerGUIDescription so the two compose to "CLI/GUI/TUI" in the GUI build: this turns "CLI" into "CLI/TUI", then the GUI rewrite turns the leading "CLI" into "CLI/GUI", yielding "CLI/GUI/TUI". In the default build the GUI rewrite is a no-op, leaving "CLI/TUI".
func RegisterTUIFlag ¶ added in v1.9.0
func RegisterTUIFlag()
RegisterTUIFlag registers the --tui launch flag on the root command, each provider group, and Azure's param/secret subgroups. It WRAPS (never replaces) each command's Before hook so it chains with the hooks already installed: enableDebug on the root and, in the GUI-embedded build, the --gui wrapper applied by registerGUIFlag. On --tui the hook resolves the provider + scope and short-circuits into the TUI, so it is registered here in the untagged commands package (unlike --gui there is no tagged stub split). Call it from main after registerGUIFlag so the --tui wrapper sits outermost.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package aws provides the "suve aws" command group: the explicit, always-present home for the AWS backends (Parameter Store, Secrets Manager, and the AWS-only staging workflow).
|
Package aws provides the "suve aws" command group: the explicit, always-present home for the AWS backends (Parameter Store, Secrets Manager, and the AWS-only staging workflow). |
|
param
Package param provides CLI commands for AWS SSM Parameter Store.
|
Package param provides CLI commands for AWS SSM Parameter Store. |
|
param/create
Package create provides the SSM Parameter Store create command.
|
Package create provides the SSM Parameter Store create command. |
|
param/delete
Package delete provides the SSM Parameter Store delete command.
|
Package delete provides the SSM Parameter Store delete command. |
|
param/paramopts
Package paramopts builds AWS Parameter Store provider write options from CLI flag values, keeping the flag-to-option mapping in one place shared by the param create and update commands.
|
Package paramopts builds AWS Parameter Store provider write options from CLI flag values, keeping the flag-to-option mapping in one place shared by the param create and update commands. |
|
param/paramtype
Package paramtype maps between the provider-neutral domain.ValueType and the AWS SSM Parameter Store type names ("String", "SecureString", "StringList") used in CLI output and in the --type flag.
|
Package paramtype maps between the provider-neutral domain.ValueType and the AWS SSM Parameter Store type names ("String", "SecureString", "StringList") used in CLI output and in the --type flag. |
|
param/update
Package update provides the SSM Parameter Store update command.
|
Package update provides the SSM Parameter Store update command. |
|
secret
Package secret provides CLI commands for AWS Secrets Manager.
|
Package secret provides CLI commands for AWS Secrets Manager. |
|
secret/create
Package create provides the Secrets Manager create command.
|
Package create provides the Secrets Manager create command. |
|
secret/delete
Package delete provides the Secrets Manager delete command.
|
Package delete provides the Secrets Manager delete command. |
|
secret/restore
Package restore provides the Secrets Manager restore command.
|
Package restore provides the Secrets Manager restore command. |
|
secret/update
Package update provides the Secrets Manager update command.
|
Package update provides the Secrets Manager update command. |
|
stage
Package stage provides the global stage command for managing staged changes.
|
Package stage provides the global stage command for managing staged changes. |
|
stage/apply
Package apply provides the global apply command for applying all staged changes.
|
Package apply provides the global apply command for applying all staged changes. |
|
stage/diff
Package diff provides the global diff command for viewing staged changes.
|
Package diff provides the global diff command for viewing staged changes. |
|
stage/param
Package param provides the param stage subcommand for staging operations.
|
Package param provides the param stage subcommand for staging operations. |
|
stage/reset
Package reset provides the global reset command for unstaging all changes.
|
Package reset provides the global reset command for unstaging all changes. |
|
stage/secret
Package secret provides the secret stage subcommand for staging operations.
|
Package secret provides the secret stage subcommand for staging operations. |
|
stage/status
Package status provides the global status command for viewing all staged changes.
|
Package status provides the global status command for viewing all staged changes. |
|
Package azure provides CLI commands for Microsoft Azure, exposed as the "suve azure secret <op>" (Key Vault) and "suve azure param <op>" (App Configuration) command groups.
|
Package azure provides CLI commands for Microsoft Azure, exposed as the "suve azure secret <op>" (Key Vault) and "suve azure param <op>" (App Configuration) command groups. |
|
param
Package param provides CLI commands for Azure App Configuration, exposed as the "suve azure param <op>" command group.
|
Package param provides CLI commands for Azure App Configuration, exposed as the "suve azure param <op>" command group. |
|
secret
Package secret provides CLI commands for Azure Key Vault secrets, exposed as the "suve azure secret <op>" command group.
|
Package secret provides CLI commands for Azure Key Vault secrets, exposed as the "suve azure secret <op>" command group. |
|
Package gcloud provides CLI commands for Google Cloud Secret Manager, exposed as the "suve gcloud secret <op>" command group plus the "suve gcloud stage <op>" staging workflow.
|
Package gcloud provides CLI commands for Google Cloud Secret Manager, exposed as the "suve gcloud secret <op>" command group plus the "suve gcloud stage <op>" staging workflow. |
|
generic
|
|
|
diff
Package diff provides the generic diff command shared by every provider.
|
Package diff provides the generic diff command shared by every provider. |
|
list
Package list provides the generic list command shared by every provider.
|
Package list provides the generic list command shared by every provider. |
|
log
Package log provides the generic log command shared by every provider.
|
Package log provides the generic log command shared by every provider. |
|
show
Package show provides the generic show command shared by every provider.
|
Package show provides the generic show command shared by every provider. |
|
tag
Package tag provides the generic tag/untag commands shared by every provider (AWS SSM Parameter Store, AWS Secrets Manager, and future providers).
|
Package tag provides the generic tag/untag commands shared by every provider (AWS SSM Parameter Store, AWS Secrets Manager, and future providers). |
|
Package internal provides shared utilities for CLI commands.
|
Package internal provides shared utilities for CLI commands. |
|
apptest
Package apptest provides helpers for constructing the CLI app with a deterministic provider-detection result, so command tests do not depend on the ambient environment (which decides the top-level param/secret aliases).
|
Package apptest provides helpers for constructing the CLI app with a deterministic provider-detection result, so command tests do not depend on the ambient environment (which decides the top-level param/secret aliases). |
Click to show internal directories.
Click to hide internal directories.