Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.atuin.enable

Whether to enable atuin.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.atuin.enableBashIntegration

Whether to enable Bash integration.

If enabled, this will bind ctrl-r to open the Atuin history.

Type: boolean

Default:

Example:

false

Declared by:

programs.atuin.enableFishIntegration

Whether to enable Fish integration.

If enabled, this will bind the up-arrow key to open the Atuin history.

Type: boolean

Default:

Example:

false

Declared by:

programs.atuin.enableNushellIntegration

Whether to enable Nushell integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.atuin.enableZshIntegration

Whether to enable Zsh integration.

If enabled, this will bind ctrl-r and the up-arrow key to open the Atuin history.

Type: boolean

Default:

Example:

false

Declared by:

programs.atuin.package

The atuin package to use.

Type: package

Default:

pkgs.atuin

Declared by:

programs.atuin.daemon.enable

Whether to enable Atuin daemon.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.atuin.daemon.logLevel

Verbosity of Atuin daemon logging.

Type: null or one of “trace”, “debug”, “info”, “warn”, “error”

Default:

null

Declared by:

programs.atuin.flags

Flags to append to the shell hook.

Type: list of string

Default:

[ ]

Example:

[
  "--disable-up-arrow"
  "--disable-ctrl-r"
]

Declared by:

programs.atuin.forceOverwriteSettings

When enabled, force overwriting of the Atuin configuration file ($XDG_CONFIG_HOME/atuin/config.toml). Any existing Atuin configuration will be lost.

Enabling this is useful when adding settings for the first time because Atuin writes its default config file after every single shell command, which can make it difficult to manually remove.

Type: boolean

Default:

false

Declared by:

programs.atuin.settings

Configuration written to $XDG_CONFIG_HOME/atuin/config.toml.

See https://docs.atuin.sh/configuration/config/ for the full list of options.

Type: Atuin configuration

Default:

{ }

Example:

{
  auto_sync = true;
  sync_frequency = "5m";
  sync_address = "https://api.atuin.sh";
  search_mode = "prefix";
}

Declared by:

programs.atuin.themes

Each theme is written to $XDG_CONFIG_HOME/atuin/themes/theme-name.toml where the name of each attribute is the theme-name

See https://docs.atuin.sh/guide/theming/ for the full list of options.

Type: attribute set of (TOML value or absolute path or strings concatenated with “\n”)

Default:

{ }

Example:

{
  "my-theme" = {
    theme.name = "My Theme";
    colors = {
      Base = "#000000";
      Title = "#FFFFFF";
    };
  };
}

Declared by: