The highest tagged major version is v3.

cmd

package

v2.0.11 Latest Latest Go to latest Published: Apr 17, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/pastdev/clconf

Links

Open Source Insights

Documentation ¶

Overview ¶

Example (NoArg) ¶

reinit()
setArgs()
Execute()

Output:
{}

Example (TestConfig) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
)
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 (TestConfigCgetvAppDbUsername) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "testdata", "test.secring.gpg"),
	"cgetv",
	"/app/db/username",
)
Execute()

Output:
SECRET_USER

Example (TestConfigGetv) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
	"getv",
)
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 (TestConfigGetvAppAliases) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "testdata", "test.secring.gpg"),
	"getv",
	"/app/aliases",
)
Execute()

Output:
- foo
- bar

Example (TestConfigGetvAppDbHostname) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
	"getv",
	"/app/db/hostname",
)
Execute()

Output:
db.pastdev.com

Example (TestConfigGetvAppDbHostnameWithDefault) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
	"--secret-keyring", filepath.Join("..", "testdata", "test.secring.gpg"),
	"getv",
	"/app/db/hostname",
	"--default", "INVALID_HOSTNAME",
)
Execute()

Output:
db.pastdev.com

Example (TestConfigGetvAppDbPort) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
	"getv",
	"/app/db/port",
)
Execute()

Output:
3306

Example (TestConfigGetvDecrypt) ¶

reinit()
setArgs(
	"--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) ¶

reinit()
setArgs(
	"--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) ¶

reinit()
setArgs(
	"--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) ¶

reinit()
setArgs(
	"--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) ¶

reinit()
setArgs(
	"--yaml", filepath.Join("..", "testdata", "testconfig.yml"),
	"getv",
	"/INVALID_PATH",
	"--default", "foo",
)
Execute()

Output:
foo

Example (WithEnvCgetvAppDbPassword) ¶

reinit()
setArgs("cgetv", "/app/db/password")
WithEnv(Execute)

Output:
SECRET_PASS

Example (WithEnvNoArg) ¶

reinit()
setArgs()
WithEnv(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

Index ¶

func Execute()
func NewExitError(exitCode int, message string) error
func NewExitErrorWrapper(exitCode int, wrapped error) error

Examples ¶

Package (NoArg)
Package (TestConfig)
Package (TestConfigCgetvAppDbUsername)
Package (TestConfigGetv)
Package (TestConfigGetvAppAliases)
Package (TestConfigGetvAppDbHostname)
Package (TestConfigGetvAppDbHostnameWithDefault)
Package (TestConfigGetvAppDbPort)
Package (TestConfigGetvDecrypt)
Package (TestConfigGetvDecryptWithPath)
Package (TestConfigGetvDecryptWithPathAndTemplate)
Package (TestConfigGetvDecryptWithPrefixAndPathAndTemplate)
Package (TestConfigGetvInvalidWithDefault)
Package (WithEnvCgetvAppDbPassword)
Package (WithEnvNoArg)

Constants ¶

This section is empty.

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.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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