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

Whether to enable mcfly.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.mcfly.enableBashIntegration

Whether to enable Bash integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.mcfly.enableFishIntegration

Whether to enable Fish integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.mcfly.enableLightTheme

Whether to enable light mode theme.

Type: boolean

Default:

false

Declared by:

programs.mcfly.enableZshIntegration

Whether to enable Zsh integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.mcfly.package

The mcfly package to use.

Type: package

Default:

pkgs.mcfly

Declared by:

programs.mcfly.fuzzySearchFactor

Whether to enable fuzzy searching. 0 is off; higher numbers weight toward shorter matches. Values in the 2-5 range get good results so far.

Type: unsigned integer, meaning >=0

Default:

0

Declared by:

programs.mcfly.fzf.enable

Whether to enable McFly fzf integration.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.mcfly.interfaceView

Interface view to use.

Type: one of “TOP”, “BOTTOM”

Default:

"TOP"

Declared by:

programs.mcfly.keyScheme

Key scheme to use.

Type: one of “emacs”, “vim”

Default:

"emacs"

Declared by:

programs.mcfly.mcflyFzfPackage

The mcfly-fzf package to use.

Type: package

Default:

pkgs.mcfly-fzf

Declared by:

programs.mcfly.settings

Settings written to ~/.config/mcfly/config.toml.

Note, if your McFly database is currently in ~/.mcfly, then this option has no effect. Move the database to $XDG_DATA_DIR/mcfly/history.db and remove ~/.mcfly to make the settings take effect. See https://github.com/cantino/mcfly#database-location.

Type: TOML value

Default:

{ }

Example:

{
  colors = {
    darkmode = {
      prompt = "cyan";
      results_selection_bg = "black";
      results_selection_fg = "cyan";
      results_selection_hl = "red";
      timing = "yellow";
    };
    menubar = {
      bg = "black";
      fg = "red";
    };
  };
}

Declared by: