Home Manager Modules - Options Documentation

kirk.fonts.enable

Whether to enable Enable my fonts, namely fira-code with nerdfonts. Note that this is required for kirk modules that use the nerdfont icons to function properly…

Type: boolean

Default:

  false

Example:

  true

kirk.foot.enable

Whether to enable foot terminal emulator.

Type: boolean

Default:

  false

Example:

  true

kirk.foot.enableKeyBindings

Whether or not to enable my keybindings.

Type: boolean

Default:

  true

kirk.foot.alpha

Alpha value of the foot terminal.

Type: floating point number

Default:

  0.85

kirk.foot.colorscheme

A colorscheme attribute set.

Type: attribute set

Default:

  {
    bg = "282828";
    black = "1d2021";
    blue = "458588";
    bright = {
      bg = "504945";
      black = "928374";
      blue = "83a598";
      fg = "fbf8e4";
      green = "b8bb26";
      orange = "fe8019";
      purple = "d3869b";
      red = "fb4934";
      teal = "8ec07c";
      white = "fbf1c7";
      yellow = "fabd2f";
    };
    fg = "ebdbb2";
    green = "98971a";
    orange = "d65d0e";
    purple = "b16286";
    red = "cc241d";
    teal = "689d6a";
    white = "d5c4a1";
    yellow = "d79921";
  }

kirk.foot.fontSize

Font size of the terminal.

Type: signed integer

Default:

kirk.git.enable

Whether to enable git.

Type: boolean

Default:

  false

Example:

  true

kirk.git.userEmail

What email address to use for git.

Type: string

kirk.git.userName

Username to use for git.

Type: string

kirk.gruvbox.colorscheme

A definition for the gruvbox theme.

Type: attribute set

Default:

  {
    bg = "282828";
    black = "1d2021";
    blue = "458588";
    bright = {
      bg = "504945";
      black = "928374";
      blue = "83a598";
      fg = "fbf8e4";
      green = "b8bb26";
      orange = "fe8019";
      purple = "d3869b";
      red = "fb4934";
      teal = "8ec07c";
      white = "fbf1c7";
      yellow = "fabd2f";
    };
    fg = "ebdbb2";
    green = "98971a";
    orange = "d65d0e";
    purple = "b16286";
    red = "cc241d";
    teal = "689d6a";
    white = "d5c4a1";
    yellow = "d79921";
  }

kirk.helix.enable

Whether to enable helix text editor.

Type: boolean

Default:

  false

Example:

  true

kirk.helix.extraPackages

Extra packages to install, for example LSP’s.

Type: list of package

Default:

[ ]

kirk.helix.installMostLsps

Whether or not to install most of the LSP’s that helix supports.

Type: boolean

Default:

  true

kirk.homeManagerScripts.enable

Whether to enable Home manager scripts. Gives access to command-line scripts that make managing home-manager easier. These scripts are lean bash scripts that compose a couple of nix and home-manager commands:

hm rebuild: Rebuild the Home Manager configuration.”
hm upgrade: Upgrade Home Manager packages. Note that this also rebuilds the configuration.”
hm options: Shows available Home Manager configuration options.”
hm garbage-collect: Garbage collects, freeing up unused hard drive space allocated to unused Nix packages.”
hm update: Updating Nix flake inputs. This updates packages for the next rebuild…”
hm test: Test the Home Manager configuration.”
hm rollback: Roll back to the previous configuration.” .

Type: boolean

Default:

  false

Example:

  true

kirk.homeManagerScripts.configDir

Path to the home-manager configuration. If not set, will default to: ${config.xdg.configHome}/home-manager.

Type: null or absolute path

Default:

  null

kirk.homeManagerScripts.disableNews

Disable annoying home-manager news on rebuild.

Type: null or boolean

Default:

  true

kirk.homeManagerScripts.machine

REQUIRED! Path to the home-manager configuration.

Type: null or string

Default:

  null

kirk.jiten.enable

Whether to enable jiten japanese dictionary.

Type: boolean

Default:

  false

Example:

  true

kirk.jiten.dailyWord

Enable daily japanese word prompt.

Type: boolean

Default:

  true

kirk.monero.enable

Whether to enable the monero node user-level systemd-service…

Type: boolean

Default:

  false

Example:

  true

kirk.monero.dataDir

The directory that the node uses for state.

Type: string

Default:

  "$HOME/.bitmonero"

kirk.monero.extraConfig

Extra configuration to pass to the node.

Type: string

Default:

""

kirk.mpv.enable

Whether to enable mpv.

Type: boolean

Default:

  false

Example:

  true

kirk.mpv.vo

Set the video output in the MPV config, must be “x11” on my work laptop for some reason, hence the default option.

Type: string

Default:

  "x11"

kirk.mvi.enable

Whether to enable mvi - the mpv image viewer.

Type: boolean

Default:

  false

Example:

  true

kirk.mvi.package

The mvi package to use.

Type: package

Default:

  <derivation mvi>

kirk.scripts.enable

Whether to enable custom scripts.

Type: boolean

Default:

  false

Example:

  true

kirk.ssh.enable

Whether to enable ssh with extra config.

Type: boolean

Default:

  false

Example:

  true

kirk.ssh.identityPath

The directory containing the path to the identity file.

Type: null or absolute path

Default:

  null

kirk.terminalTools.enable

Terminal tools to make your life easier. The installed packages are:

terminal-tools: Displays this message
bat: Pretty cat with syntax highlighting
batman: Pretty Man Pages
btop: Task Manager
dust: Pretty du for seeing disk usage
duf: Pretty df
eza: Pretty ls
fd: Find Files
fzf: Search text
jq: JSON Parser
rig: Random Identities for Privacy
ag: Search in Files
tldr: TLDR for CLI Commands
trash-cli: Trash Files in Terminal
- trash-put: Trash file or directory
- trash-list: List trashed files
- trash-restore: Restore trashed files
- trash-empty: Delete trashed files
- trash-rm: Removes files matching a pattern from the trash can
tree: View Directory as Tree

The option enableZshIntegration yields the following helper commands:

help <command>: Runs <command> --help, but prettier
fif <string>: Finds finds that <string> recursively in directory
ll: Pretty ll
lh: Pretty lh

Type: boolean

Default:

  false

kirk.terminalTools.enableZshIntegration

Whether to enable zsh integration for bat and fzf.

Type: boolean

Default:

  true

kirk.terminalTools.bat.theme

What syntax highlighting colorscheme to use.

Type: string

Default:

  "gruvbox-dark"

kirk.terminalTools.fzf.colorscheme

A colorscheme attribute set.

Type: attribute set

Default:

  {
    bg = "282828";
    black = "1d2021";
    blue = "458588";
    bright = {
      bg = "504945";
      black = "928374";
      blue = "83a598";
      fg = "fbf8e4";
      green = "b8bb26";
      orange = "fe8019";
      purple = "d3869b";
      red = "fb4934";
      teal = "8ec07c";
      white = "fbf1c7";
      yellow = "fabd2f";
    };
    fg = "ebdbb2";
    green = "98971a";
    orange = "d65d0e";
    purple = "b16286";
    red = "cc241d";
    teal = "689d6a";
    white = "d5c4a1";
    yellow = "d79921";
  }

kirk.terminalTools.tealdeer.autoUpdate

Whether to auto-update tealdeer.

Type: boolean

Default:

  true

kirk.terminalTools.trashCleaner.enable

Enable the trash-cli cleanup script

Type: boolean

Default:

  true

kirk.terminalTools.trashCleaner.persistance

How many days a file stays in trash before getting cleaned up.

Type: signed integer or floating point number

Default:

kirk.userDirs.enable

Whether to enable userDirs.

Type: boolean

Default:

  false

Example:

  true

kirk.userDirs.autoSortDownloads

Whether or not to auto-sort downloads.

Type: boolean

Default:

  true

kirk.xdgMime.enable

Whether to enable xdg-mime associations. Warning, this depends on various other submodules from this root module.

Type: boolean

Default:

  false

Example:

  true

kirk.yazi.enable

Whether to enable yazi file manager.

Type: boolean

Default:

  false

Example:

  true

kirk.yazi.configDir

The path to the nix configuration directory.

Type: null or absolute path

Default:

  null

kirk.zathura.enable

Whether to enable foot terminal emulator.

Type: boolean

Default:

  false

Example:

  true

kirk.zathura.enableKeyBindings

Whether or not to enable my keybindings.

Type: boolean

Default:

  true

kirk.zathura.colorscheme

A colorscheme attribute set.

Type: attribute set

Default:

  {
    bg = "282828";
    black = "1d2021";
    blue = "458588";
    bright = {
      bg = "504945";
      black = "928374";
      blue = "83a598";
      fg = "fbf8e4";
      green = "b8bb26";
      orange = "fe8019";
      purple = "d3869b";
      red = "fb4934";
      teal = "8ec07c";
      white = "fbf1c7";
      yellow = "fabd2f";
    };
    fg = "ebdbb2";
    green = "98971a";
    orange = "d65d0e";
    purple = "b16286";
    red = "cc241d";
    teal = "689d6a";
    white = "d5c4a1";
    yellow = "d79921";
  }

kirk.zathura.darkmode

Enable darkmode on recolor.

Type: boolean

Default:

  true

kirk.zsh.enable

Whether to enable zsh configuration…

Type: boolean

Default:

  false

Example:

  true