Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

set

The rumi set command views and changes Rumi CLI settings. Settings are per-user preferences about how the CLI itself behaves, and they persist across CLI upgrades.

Usage

rumi set                      # list every setting and its current value
rumi set <setting> <value>    # change a setting

Settings

Setting
Values
Default
Description

stacktrace

on | off

off

Print a Java stack trace when a command fails

on and off are the documented spellings. true/false, yes/no, and 1/0 are accepted as synonyms and normalized to on/off when stored.

Examples

List the current settings:

$ rumi set

      SETTING        VALUE    DEFAULT  DESCRIPTION
      stacktrace     off      off      Print a Java stack trace when a command fails

      settings file: /Users/you/.nvx/rumi-cli/settings.properties

      Run 'rumi set <setting> <value>' to change one.

Turn stack traces on:

stacktrace

By default, a failing command prints only its message:

Most failures are like this one: an expected condition with a message that already tells you what to do. The stack trace is diagnostic detail that gets in the way of reading it.

Turn stacktrace on when you are diagnosing a genuine defect, or when you have been asked for the full trace in a support request:

Where Settings Are Stored

Settings live in a per-user file:

Set the NVX_HOME environment variable to relocate the base directory, in which case the file is $NVX_HOME/rumi-cli/settings.properties. This is useful in CI, where you may want settings isolated per job.

The file is plain Java properties and safe to read or edit by hand:

If the file is missing or unreadable, every setting falls back to its default and commands run normally.

Settings are deliberately not stored in the CLI installation directory. That directory is commonly root-owned, so rumi set could not write to it, and it is replaced wholesale on upgrade, which would discard your preferences. $RUMI_CLI_HOME/conf/cli.conf is a different thing: it is install-scoped runtime configuration, such as JVM options, not user preference.

See Also

PreviousversionNextquickstart

Last updated