Skip to content
Atuin

atuin config

Get, set, or print values in your atuin config file

Terminal window
atuin config <COMMAND>

Get a configuration value from your config.toml file or after defaults and overrides are applied

Terminal window
atuin config get [OPTIONS] <KEY>
  • <KEY>: The configuration key to get
  • -r, --resolved: Print the value after defaults and overrides are applied
  • -v, --verbose: Print both the config file value and the resolved value

Set a configuration value in your config.toml file

Terminal window
atuin config set [OPTIONS] <KEY> <VALUE>
  • <KEY>: The configuration key to set
  • <VALUE>: The value to set
  • -t <TYPE>, --type <TYPE>: Store value as an explicit type. Default: auto.
    • auto: Automatically determine the type of the value
    • string: Store value as a string
    • boolean: Store value as a boolean
    • integer: Store value as an integer
    • float: Store the value as a float
  • --force: Set the key even if Atuin does not recognize it

Print all configuration values from your config.toml file in TOML format

If a key is provided, only print the value of that key and all its children

Terminal window
atuin config print [KEY]
  • <KEY>: Print the value of a specific key and all its children

Check your configuration for settings that Atuin does not recognize

Atuin ignores settings it doesn’t recognize. This command checks if your config contains any unrecognized settings, and prints them and exits with an error if so.

Terminal window
atuin config check

Print the Luau types of atuin.lua and .atuin.lua config files, for your editor. The types are for files that start with -- atuin:version=1.

Save the output, say as ~/.atuin/atuin.d.luau, and list it in luau-lsp’s luau-lsp.types.definitionFiles setting. The table a config file assigns to atuin.config then checks and completes as you write it.

Terminal window
atuin config types