ContextQMD
Back to Materialize

mz config

doc/user/content/integrations/cli/reference/config.md

1232.2 KB
Original Source

The mz config command manages global configuration parameters for mz.

get

Get the value of a configuration parameter.

shell
mz config get <NAME> [options...]

See Global parameters for a description of the available configuration parameters.

Arguments

ArgumentEnvironment variablesDescription
<NAME>Required. The name of the configuration parameter to get.

Examples

Get the default profile:

shell
$ mz config get profile

acme-corp

list, ls

List all configuration parameters.

shell
mz config {list,ls} [options...]

See Global parameters for a description of the available configuration parameters.

Examples

shell
$ mz config list

Name    | Value
--------|----------
profile | default
vault   | keychain

remove, rm

Remove a configuration parameter.

shell
mz config {remove,rm} <NAME> [options...]

See Global parameters for a description of the available configuration parameters.

Arguments

ArgumentEnvironment variablesDescription
<NAME>Required. The name of the configuration parameter to remove.

Examples

Remove the vault configuration parameter:

shell
mz config remove vault

set

Set a configuration parameter.

shell
mz config set <NAME> <VALUE> [options...]

See Global parameters for a description of the available configuration parameters.

Arguments

ArgumentEnvironment variablesDescription
<NAME>Required. The name of the configuration parameter to set.
<VALUE>Required. The value to set the configuration parameter to.

Examples

Set the profile configuration parameter to hooli:

shell
mz config set profile hooli

Global flags

{{% cli-global-args %}}