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.broot.enable

Whether to enable Broot, a better way to navigate directories.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.broot.enableBashIntegration

Whether to enable Bash integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.broot.enableFishIntegration

Whether to enable Fish integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.broot.enableNushellIntegration

Whether to enable Nushell integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.broot.enableZshIntegration

Whether to enable Zsh integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.broot.package

The broot package to use.

Type: package

Default:

pkgs.broot

Declared by:

programs.broot.settings

Verbatim config entries

Type: open submodule of (JSON value)

Default:

{ }

Declared by:

programs.broot.settings.modal

Whether to enable modal (vim) mode.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.broot.settings.skin

Color configuration.

Complete list of keys (expected to change before the v1 of broot):

  • char_match
  • code
  • directory
  • exe
  • file
  • file_error
  • flag_label
  • flag_value
  • input
  • link
  • permissions
  • selected_line
  • size_bar_full
  • size_bar_void
  • size_text
  • spinner
  • status_error
  • status_normal
  • table_border
  • tree
  • unlisted

Add _fg for a foreground color and _bg for a background color.

Type: attribute set of string

Default:

{ }

Example:

{
  code_fg = "lightyellow";
  directory_fg = "lightyellow";
  flag_value_fg = "lightyellow";
  input_fg = "cyan";
  permissions_fg = "grayscale(12)";
  selected_line_bg = "grayscale(7)";
  size_bar_full_bg = "red";
  size_bar_void_bg = "black";
  status_error_bg = "yellow";
  status_error_fg = "red";
  status_normal_bg = "grayscale(3)";
  status_normal_fg = "grayscale(18)";
  table_border_fg = "red";
  tree_fg = "red";
}

Declared by:

programs.broot.settings.verbs

Define new verbs. For more information, see Verb Definition Attributes in the broot documentation.

The possible attributes are:

  • ‌invocation (optional)‌

    how the verb is called by the user, with placeholders for arguments

  • ‌execution (mandatory)‌

    how the verb is executed

  • ‌key (optional)‌

    a keyboard key triggering execution

  • ‌keys (optional)‌

    multiple keyboard keys each triggering execution

  • ‌shortcut (optional)‌

    an alternate way to call the verb (without the arguments part)

  • ‌leave_broot (optional)‌

    whether to quit broot on execution (default: true)

  • ‌from_shell (optional)‌

    whether the verb must be executed from the parent shell (default: false)

Type: list of attribute set of (boolean or string or list of string)

Default:

[ ]

Example:

[
  { invocation = "p"; execution = ":parent"; }
  { invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; }
  { invocation = "create {subpath}"; execution = "$EDITOR {directory}/{subpath}"; }
  { invocation = "view"; execution = "less {file}"; }
  {
    invocation = "blop {name}\\.{type}";
    execution = "mkdir {parent}/{type} && ${pkgs.neovim}/bin/nvim {parent}/{type}/{name}.{type}";
    from_shell = true;
  }
]

Declared by: