cmd

package
v3.0.17 Latest Latest
Warning

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

 Go to latest Published: May 8, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Example (GetvArrayAsBashArray) 
_ = newCmd("getv", "--var", `/a=["foo","bar"]`, "/a", "--as-bash-array").Execute()

Output:
([0]="foo" [1]="bar")
Example (GetvArrayOfObjectsAsBashArray) 
_ = newCmd("getv", "--var", `/a=[{"foo":"bar"},{"hip":"hop"}]`, "/a", "--as-bash-array").Execute()

Output:
([0]="{\"foo\":\"bar\"}" [1]="{\"hip\":\"hop\"}")
Example (GetvMapAsBashArray) 
_ = newCmd("getv", "--var", `/a={"foo":"bar","hip":"hop"}`, "/a", "--as-bash-array").Execute()

Output:
([0]="{\"key\":\"foo\",\"value\":\"bar\"}" [1]="{\"key\":\"hip\",\"value\":\"hop\"}")
Example (GetvMultipleVar) 
_ = newCmd("getv", "--var", `/foo/baz="bar"`, "--var", `/foo/hip="hop"`).Execute()

Output:
foo:
  baz: bar
  hip: hop
Example (GetvObject) 
_ = newCmd("getv", "--var", `/={"foo":{"baz":"bar","hip":"hop"}}`).Execute()

Output:
foo:
  baz: bar
  hip: hop
Example (GetvScalarAsBashArray) 
_ = newCmd("getv", "--var", `/a="bar"`, "/a", "--as-bash-array").Execute()

Output:
([0]="bar")
Example (GetvStringAsJson) 
_ = newCmd("getv", "--var", `/foo="bar"`, "/foo", "--as-json").Execute()

Output:
"bar"
Example (GetvTemplateArrayAsJson) 
_ = newCmd(
	"getv",
	"--var", `/foo=["hip", "hop", "bar","baz"]`,
	"/foo",
	"--output", "go-template",
	"--template", `{{asJson (getksvs "/*" "int")}}`,
).Execute()

Output:
["hip","hop","bar","baz"]
Example (GetvVar) 
_ = newCmd("getv", "--var", `/foo="bar"`).Execute()

Output:
foo: bar
Example (MergeOverridesBooleanToFalse) 
footrue, err := os.CreateTemp("", "")
if err != nil {
	return
}
defer func() { _ = os.Remove(footrue.Name()) }()

if _, err := footrue.Write([]byte("---\nfoo: true")); err != nil {
	return
}

foofalse, err := os.CreateTemp("", "")
if err != nil {
	return
}
defer func() { _ = os.Remove(foofalse.Name()) }()

if _, err := foofalse.Write([]byte("---\nfoo: false")); err != nil {
	return
}

_ = newCmd("getv", "--yaml", footrue.Name(), "--yaml", foofalse.Name()).Execute()

Output:
foo: false
Example (NoArg) 
_ = newCmd().Execute()

Output:
{}
Example (Patch) 
patch, err := os.CreateTemp("", "")
if err != nil {
	return
}
defer func() { _ = os.Remove(patch.Name()) }()

if _, err = patch.Write([]byte(`[{"op":"replace","path":"/foo","value":"baz"}]`)); err != nil {
	return
}

_ = newCmdWithYaml(`foo: bar`, "--patch", patch.Name(), "getv", "/").Execute()

Output:
foo: baz
Example (Patch_string) 
_ = newCmdWithYaml(
	`foo: bar`,
	"--patch-string",
	`[{"op":"replace","path":"/foo","value":"baz"}]`,
	"getv",
	"/",
).Execute()

Output:
foo: baz
Example (PreserveListOrderInRange) 
yaml := `
a_list:
- zebra
- elephant
- cat
- unicorn
`
_ = newCmdWithYaml(yaml, "getv", "/", "--template-string",
	`{{ range (getksvs "/a_list/*" "int") }}{{.}}{{"\n"}}{{ end }}`).Execute()

Output:
zebra
elephant
cat
unicorn
Example (ScalarDefaultOutput)

see https://github.com/pastdev/clconf/issues/47 

yaml := `
example: '
   This is a string value.
'
`
// print out leader and trailer chars to demonstrate leading and trailing
// spaces that get ignored by go Example testing by default
fmt.Print(">>>")
_ = newCmdWithYaml(yaml, "getv", "/example").Execute()
fmt.Print("<<<")

Output:
>>> This is a string value. <<<
Example (ScalarYamlOutput)

see https://github.com/pastdev/clconf/issues/47 

yaml := `
example: '
   This is a string value.
'
`
_ = newCmdWithYaml(yaml, "getv", "/example", "--output", "yaml").Execute()

Output:
' This is a string value. '
Example (SortListInRange) 
yaml := `
a_list:
- zebra
- elephant
- cat
- unicorn
`
_ = newCmdWithYaml(yaml, "getv", "/", "--template-string",
	`{{ range getsvs "/a_list/*" }}{{.}}{{"\n"}}{{ end }}`).Execute()

Output:
cat
elephant
unicorn
zebra
Example (TestConfig) 
yaml := `
app:
  db:
    username: someuser
    password: somepass
    schema: appdb
    hostname: db.example.com
`
_ = newCmdWithYaml(yaml).Execute()

Output:
app:
  db:
    hostname: db.example.com
    password: somepass
    schema: appdb
    username: someuser
Example (TestConfigCgetvAppDbUsername) 
_ = newCmd(
	"--yaml", filepath.Join("..", "..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "..", "testdata", "test.secring.gpg"),
	"cgetv",
	"/app/db/username",
).Execute()

Output:
SECRET_USER
Example (TestConfigGetv) 
yaml := `
app:
  db:
    username: someuser
    password: somepass
    schema: appdb
    hostname: db.example.com
`
_ = newCmdWithYaml(yaml, "getv").Execute()

Output:
app:
  db:
    hostname: db.example.com
    password: somepass
    schema: appdb
    username: someuser
Example (TestConfigGetvAppAliases) 
yaml := `
app:
  db:
    username: someuser
    password: somepass
    schema: appdb
    hostname: db.example.com
    port: 3306
  aliases:
  - foo
  - bar
`
_ = newCmdWithYaml(yaml, "getv", "/app/aliases").Execute()

Output:
- foo
- bar
Example (TestConfigGetvAppDbHostname) 
yaml := `
app:
  db:
    username: someuser
    password: somepass
    schema: appdb
    hostname: db.example.com
    port: 3306
  aliases:
  - foo
  - bar
`
_ = newCmdWithYaml(yaml, "getv", "/app/db/hostname").Execute()

Output:
db.example.com
Example (TestConfigGetvAppDbHostnameWithDefault) 
yaml := `
app:
  db:
    username: someuser
    password: somepass
    schema: appdb
    hostname: db.example.com
    port: 3306
  aliases:
  - foo
  - bar
`
_ = newCmdWithYaml(yaml, "getv", "/app/db/hostname", "--default", "INVALID_HOSTNAME").Execute()

Output:
db.example.com
Example (TestConfigGetvAppDbPort) 
yaml := `
app:
  db:
    username: someuser
    password: somepass
    schema: appdb
    hostname: db.example.com
    port: 3306
  aliases:
  - foo
  - bar
`
_ = newCmdWithYaml(yaml, "getv", "/app/db/port").Execute()

Output:
3306
Example (TestConfigGetvDecrypt) 
_ = newCmd(
	"--yaml", filepath.Join("..", "..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "..", "testdata", "test.secring.gpg"),
	"getv",
	"--decrypt", "/app/db/username",
	"--decrypt", "/app/db/password",
).Execute()

Output:
app:
  aliases:
  - foo
  - bar
  db:
    hostname: db.pastdev.com
    password: SECRET_PASS
    password-plaintext: SECRET_PASS
    port: 3306
    schema: clconfdb
    username: SECRET_USER
    username-plaintext: SECRET_USER
Example (TestConfigGetvDecryptWithPath) 
_ = newCmd(
	"--yaml", filepath.Join("..", "..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "..", "testdata", "test.secring.gpg"),
	"getv",
	"/app/db",
	"--decrypt", "/username",
	"--decrypt", "/password",
).Execute()

Output:
hostname: db.pastdev.com
password: SECRET_PASS
password-plaintext: SECRET_PASS
port: 3306
schema: clconfdb
username: SECRET_USER
username-plaintext: SECRET_USER
Example (TestConfigGetvDecryptWithPathAndTemplate) 
_ = newCmd(
	"--yaml", filepath.Join("..", "..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "..", "testdata", "test.secring.gpg"),
	"getv",
	"/app/db",
	"--template-string", "{{ cgetv \"/username\" }}:{{ cgetv \"/password\" }}",
).Execute()

Output:
SECRET_USER:SECRET_PASS
Example (TestConfigGetvDecryptWithPrefixAndPathAndTemplate) 
_ = newCmd(
	"--yaml", filepath.Join("..", "..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "..", "testdata", "test.secring.gpg"),
	"--prefix", "/app/db",
	"getv",
	"/",
	"--template-string", "{{ cgetv \"/username\" }}:{{ cgetv \"/password\" }}",
).Execute()

Output:
SECRET_USER:SECRET_PASS
Example (TestConfigGetvInvalidWithDefault) 
yaml := `
app:
  db:
    username: someuser
    password: somepass
    schema: appdb
    hostname: db.example.com
    port: 3306
  aliases:
  - foo
  - bar
`
_ = newCmdWithYaml(yaml, "getv", "/INVALID_PATH", "--default", "foo").Execute()

Output:
foo
Example (TestList) 
_ = newCmd(
	"--yaml", filepath.Join("..", "..", "testdata", "testrootlist.yml"),
).Execute()

Output:
- foo: bar
- foo: baz
Example (Var) 
_ = newCmd("var", "/foo", "bar").Execute()

Output:
/foo="bar"
Example (VarArray) 
_ = newCmd("var", "/foo", "bar", "baz").Execute()

Output:
/foo=["bar","baz"]
Example (VarForceArray) 
_ = newCmd("var", "/foo", "bar", "--force-array").Execute()

Output:
/foo=["bar"]
Example (VarForceArrayValueOnly) 
_ = newCmd("var", "/foo", "bar", "--force-array", "--value-only").Execute()

Output:
["bar"]
Example (VarValueOnly) 
_ = newCmd("var", "/foo", "bar", "--value-only").Execute()

Output:
"bar"
Example (WithEnvCgetvAppDbPassword) 
WithEnv(func() { _ = newCmd("cgetv", "/app/db/password").Execute() })

Output:
SECRET_PASS
Example (WithEnvNoArg) 
WithEnv(func() { _ = newCmd().Execute() })

Output:
app:
  aliases:
  - foo
  - bar
  db:
    hostname: db.pastdev.com
    password: wcBMA5B5A4w5Zw+rAQgALW6c2D2wwgonToJuQUmDGlnw3LG8L4dOq4qgf27L+s133trGcmBpGdsS3XysbkQ6TaYJ2y7wLpHs/dHSwrD2Z+M6WvLX5mzBhAAY5rIN+KLal7vepU+OumPGbq14kZSAYAhfkVAPxg21P04P1N/S853VPrjpeVlGWBLJMdXsGmdGLgelMAT5koSprnovsBEhm0te33KbEXSkvFVZCMF0rBwK4GV2YfPOhTwFLZCQ451Gl3fLUrdxGS6Bn9pZHl83m3lD8bFdX5kV4ezF48WREE9al3Ik/EEjcKEki2sF65mKK8a5mtEdlw8i2TzRXReUMX+QNFxNbmTyKPGpoQJ4DdLgAeS60Ee2yg9bYuB8LymvpIXe4fcj4E/gxuF9MOBb4j1cxWXg0+OcNwC7jnKTc+A04aAE4OzjvXAkVzP71PTgDuJ5DgRi4JHg3eCK4iRchCPgp+NuvJFazIksrODo5GwKh2URof5RNlbGwzLSmPvio8O96uEXYwA=
    password-plaintext: SECRET_PASS
    port: 3306
    schema: clconfdb
    username: wcBMA5B5A4w5Zw+rAQgAUfuQEe3XCfWey2j51dIl6BiDyMVcGu2nOUV+CS4GLF/AW2KfThIWICxYDEpbJhxFnGqHDkdFI8q5YowS8XDKuezJXwwkvKJkDswMiIJsHVRIoIW2kvXZHS0fJIqPN0mpUl2uPmDd+lELduV21ix4j+yO1frEgbAmKtAHvfvs5QqPOquOZVFWRnHP0SQ1Ev+argq+c1OrbSPXlGplFgfpyJWoq1vt4K2OL//us6fZtAPgNHGTIK+0hFZSTfJ7vBqEygolAO581G9fsUHWJJ+0KBj4xHy7J91mCTCCCl8gbUe6ANtSMHGcl8aNuYL6IRvOEbtZVM8MUE6MWY+k/pPABNLgAeRftcnVfmbiydJ9DXfcFePC4f364H/gcuG3AOA34mINQVng2uOpfWLop/Vv6+CE4fZy4N7jJSWyE0LgXMzgqeLRG2vc4Lvg/uAN4kxVe67gq+PSZuU8WdmEouC15LbaCnISJ/Du6cc34mhqi7DiMWHP6+EPfgA=
    username-plaintext: SECRET_USER
Example (WithEnvVarEmpty) 
WithExplicitEnv(
	map[string]string{"YAML_VARS": "", "YAML_FILES": ""},
	func() { _ = newCmd().Execute() })

Output:
{}

Index

Examples

Constants

View Source 
const DefaultOutput = "value"

Variables

This section is empty.

Functions

func Execute 

func Execute()

Execute runs the root command

func NewExitError 

func NewExitError(exitCode int, message string) error

NewExitError creates a new error that holds an exit code.

func NewExitErrorWrapper 

func NewExitErrorWrapper(exitCode int, wrapped error) error

NewExitErrorWrapper creates a new error that holds an exit code.

func ToJSONLines added in v3.0.7 

func ToJSONLines(value interface{}) ([]string, error)

Types

type Marshaler 

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

func (*Marshaler) AddFlags 

func (c *Marshaler) AddFlags(cmd *cobra.Command)

func (Marshaler) Marshal 

func (c Marshaler) Marshal(value interface{}) (string, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.