Documentation
¶
Overview ¶
Package cli wires the cobra command tree for roksbnkctl.
Build-time variables (Version, Commit, BuildDate) are populated via -ldflags by goreleaser / Makefile.
Index ¶
Constants ¶
const DocsURL = "https://jgruberf5.github.io/roksbnkctl/book/"
DocsURL is the canonical user documentation surface for roksbnkctl — the published mdBook at GitHub Pages. Single source of truth so the `version` subcommand, the cobra-wired `--version` flag, and the `self update` flow all surface the same URL.
Variables ¶
var ( Version = "dev" Commit = "none" BuildDate = "unknown" )
Build metadata, populated via -ldflags at link time.
Functions ¶
func Execute ¶
func Execute()
Execute runs the root command. Wires SIGINT (Ctrl+C) to a cancellable context so long-running operations like terraform apply terminate promptly and child processes get cleaned up.
Loads $PWD/.env at startup if present — godotenv's Load does NOT overwrite existing env vars, so anything already in the shell wins. Lets users keep IBMCLOUD_API_KEY, GITHUB_TOKEN, TF_VAR_* etc. in a project-scoped file instead of shell profiles.
func RootCommand ¶ added in v1.0.0
RootCommand returns the wired-up root cobra command for tooling that needs to walk the command tree (e.g. the cobra-to-markdown reference generator under tools/refgen/cobra-md). Subcommands are registered via package-level init() funcs, so the tree is fully assembled before any caller imports this package.
Callers MUST NOT mutate the returned command — it's the same instance Execute() runs.
Types ¶
This section is empty.
Source Files
¶
- agent.go
- apikey.go
- backend.go
- bnk_phase.go
- bnkforge.go
- bnkforge_cmd.go
- bnkforge_sshcred.go
- cleanup.go
- cluster.go
- cluster_phase.go
- cluster_vpc_guard.go
- cmdctx.go
- config_cmd.go
- cos.go
- doctor_backend.go
- doctor_stale_kubeconfig.go
- flp_phase.go
- flp_postrender.go
- flp_status.go
- gateway_phase.go
- init.go
- init_example.go
- init_supply_chain.go
- inspect.go
- install.go
- journal.go
- k_aliases.go
- k_apply.go
- k_delete.go
- k_describe.go
- k_exec.go
- k_get.go
- k_logs.go
- k_port_forward.go
- k_root.go
- kubeconfig_scope.go
- lifecycle.go
- meta.go
- ops.go
- passthrough_kubetarget.go
- phase_output.go
- phase_status.go
- prompt.go
- registry.go
- registry_adopt.go
- registry_bom.go
- registry_ca.go
- registry_delete.go
- registry_diff.go
- registry_prune.go
- registry_replicate.go
- registry_target_cmd.go
- registry_verify.go
- remote.go
- root.go
- seedinput.go
- self.go
- selfheal.go
- state.go
- targets.go
- terraform.go
- test.go
- test_hosts.go
- test_matrix.go
- test_matrix_fixtures.go
- testing_phase.go
- tfvars.go
- tfx.go
- tfx_apply.go
- tfx_argshift.go
- tfx_cos_get.go
- tfx_delete.go
- tfx_far_extract.go
- tfx_helm_value.go
- tfx_patch.go
- tfx_read_json.go
- tfx_wait.go
- tgw_phase.go
- uninstall.go
- vpc_prefix_guard.go
- workspaces.go