Skip to content

phenix settings

Every command on this page also accepts the global flags.

phenix settings

View, list, or edit phenix system settings

phenix settings [flags]

Options

  -h, --help   help for settings

SEE ALSO

phenix settings db

View or edit legacy database settings

Synopsis

Manage legacy settings stored in the internal database. For active runtime configuration (logging, etc.), use the root settings commands (get/set).
phenix settings db [flags]

Options

  -h, --help   help for db

SEE ALSO

phenix settings db edit

Edit a setting in the database

Synopsis

Edit a setting in the database. This command does not change the log settings: use 'phenix settings set' for them (for example, phenix settings set log.system.max-size 100).
phenix settings db edit <category> <name> <value> [flags]

Examples

phenix settings db edit <category> <name> <newValue>
phenix settings db edit Password MinLength 20

Options

  -h, --help   help for edit

SEE ALSO

phenix settings db list

List settings in the database

phenix settings db list [category] [flags]

Options

  -h, --help            help for list
      --json            Output as JSON (the same as -o json)
  -o, --output string   Output format (table, json, yaml) (default "table")

SEE ALSO

phenix settings get

Get configuration value(s)

Synopsis

Gets a configuration value from the runtime configuration. If no key is provided, returns all settings.
phenix settings get [key] [flags]

Examples

phenix settings get
phenix settings get log.level
phenix settings get log -o json

Options

  -h, --help            help for get
      --json            Output as JSON (the same as -o json)
  -o, --output string   Output format (table, json, yaml) (default "yaml")

SEE ALSO

phenix settings list

List all runtime settings

phenix settings list [flags]

Options

      --filter string   Filter settings by key prefix
  -h, --help            help for list
      --json            Output as JSON (the same as -o json)
  -o, --output string   Output format (table, json, yaml) (default "table")

SEE ALSO

phenix settings set

Set a configuration value

Synopsis

Sets a configuration value in the YAML config file phenix read, or, when it read none, in $HOME/.config/phenix/config.yaml (/etc/phenix/config.yaml as root), creating it. A flag or PHENIX_ environment variable for the key still overrides the file. The value of a phenix setting must have the type of its flag, such as an integer for log.system.max-size; a string setting keeps the text as it is. For other keys, true or false becomes a boolean and a number becomes a number. Comments and the other keys in the file stay.
phenix settings set <key> <value> [flags]

Examples

phenix settings set log.level debug
phenix settings set log.system.max-size 200

Options

  -h, --help   help for set

SEE ALSO

phenix settings unset

Unset configuration value(s)

Synopsis

Unsets a configuration value in the config file phenix read, so a PHENIX_ environment variable or the default applies. Comments and the other keys in the file stay. A key that is not in the file does not change the file. Use --all to reset all settings. With --dry-run, phenix shows the key that it would remove, or the config file that it would delete, and changes nothing.
phenix settings unset [key] [flags]

Examples

phenix settings unset log.level
phenix settings unset log.level --dry-run
phenix settings unset --all

Options

      --all       Unset all settings (delete configuration file)
      --dry-run   Show what the command would change, and change nothing
  -h, --help      help for unset

SEE ALSO