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

  false

  true

kirk.foot.enable

Whether to enable foot terminal emulator.

Type: boolean

  false

  true

kirk.foot.enableKeyBindings

Whether or not to enable my keybindings.

Type: boolean

  true

kirk.foot.alpha

Alpha value of the foot terminal.

Type: floating point number

  0.85

kirk.foot.colorscheme

A colorscheme attribute set.

Type: attribute set

  {
    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

  15

kirk.fzf.enable

Whether to enable foot terminal emulator.

Type: boolean

  false

  true

kirk.fzf.enableZshIntegration

Whether to enable zsh integration.

Type: boolean

  true

kirk.fzf.colorscheme

A colorscheme attribute set.

Type: attribute set

  {
    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.git.enable

Whether to enable git.

Type: boolean

  false

  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

  {
    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

  false

  true

kirk.helix.extraPackages

Extra packages to install, for example LSP’s.

Type: list of package

  [ ]

kirk.helix.installMostLsps

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

Type: boolean

  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-update: Updates the available packages, usually, you don’t need to run this, but the other scripts use it.
• hm-clean: Cleans up older configurations and garbage collects the nix store, cleaning up unused packages and freeing up harddisk space
• hm-rebuild: Builds your configuration. Backs up files; if you fx have a .bashrc and home-manager needs to overwrite it, the old .bashrc is renamed to .bashrc.bck
• hm-upgrade: Updates all packages, rebuilds and finally older configurations/garbage collects
• hm-rollback: Use this command to roll back to a previous working home manager configuration.

.

Type: boolean

  false

  true

kirk.homeManagerScripts.configDir

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

Type: null or path

  null

kirk.homeManagerScripts.machine

REQUIRED! Path to the home-manager configuration.

Type: null or string

kirk.jiten.enable

Whether to enable jiten japanese dictionary.

Type: boolean

  false

  true

kirk.jiten.dailyWord

Enable daily japanese word prompt.

Type: boolean

  true

kirk.joshuto.enable

Whether to enable joshuto file manager.

Type: boolean

  false

  true

kirk.joshuto.enableZshIntegration

Adds the auto-cd j command to zsh.

Type: boolean

  true

kirk.kakoune.enable

Whether to enable kakoune text editor.

Type: boolean

  false

  true

kirk.scripts.enable

Whether to enable custom scripts.

Type: boolean

  false

  true

kirk.ssh.enable

Whether to enable ssh with extra config.

Type: boolean

  false

  true

kirk.ssh.identityPath

The directory containing the path to the identity file.

Type: null or path

  null

kirk.terminalTools.enable

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

• terminal-tools: Displays this message

• batman: Pretty Man Pages

• btop: Task Manager

• dust: Pretty du

• duf: Pretty df

• eza: Pretty ls

• fd: Find Files

• 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

  false

kirk.terminalTools.enableZshIntegration

Whether to enable zsh integration for bat.

Type: boolean

  true

kirk.terminalTools.autoUpdateTealdeer

Whether to auto-update tealdeer.

Type: boolean

  true

kirk.terminalTools.theme

What syntax highlighting colorscheme to use.

Type: string

  "gruvbox-dark"

kirk.terminalTools.trashCleaner.enable

Enable the trash-cli cleanup script

Type: boolean

  true

kirk.terminalTools.trashCleaner.persistance

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

Type: signed integer or floating point number

  30

kirk.userDirs.enable

Whether to enable userDirs.

Type: boolean

  false

  true

kirk.userDirs.autoSortDownloads

Whether or not to auto-sort downloads.

Type: boolean

  true

kirk.yazi.enable

Whether to enable yazi file manager.

Type: boolean

  false

  true

kirk.yazi.configDir

The path to the nix configuration directory.

Type: null or path

  null

kirk.zathura.enable

Whether to enable foot terminal emulator.

Type: boolean

  false

  true

kirk.zathura.enableKeyBindings

Whether or not to enable my keybindings.

Type: boolean

  true

kirk.zathura.colorscheme

A colorscheme attribute set.

Type: attribute set

  {
    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

  true

kirk.zsh.enable

Whether to enable zsh configuration…

Type: boolean

  false

  true