NixOS Module Options

`my-dotfiles.bat.enable`

install and configure bat

Type: boolean

Default: false

Example: true

`my-dotfiles.bat.enableBatman`

Enable batman for reading manpages.

Type: lib.types.bool

Default: true

`my-dotfiles.bitwarden.enable`

install Bitwarden

Type: boolean

Default: false

Example: true

`my-dotfiles.bitwarden.useForSSHAgent`

use Bitwarden as the ssh-agent

Type: boolean

Default: false

Example: true

`my-dotfiles.btop.enable`

install and configure btop

Type: boolean

Default: false

Example: true

`my-dotfiles.carapace.enable`

install and configure carapace

Type: boolean

Default: false

Example: true

`my-dotfiles.carapace.overlays`

Completion overlays to install in the carapace config directory.

Type: lib.types.attrsOf yamlFormat.type

Default: { }

`my-dotfiles.devenv.enable`

install devenv

Type: boolean

Default: false

Example: true

`my-dotfiles.devenv.inPrompt`

show git info in the shell prompt

Type: boolean

Default: false

Example: true

`my-dotfiles.direnv.enable`

install direnv

Type: boolean

Default: false

Example: true

`my-dotfiles.direnv.hideDiff`

hide the environment variable diff

Type: boolean

Default: false

Example: true

`my-dotfiles.discord.betterdiscord.enable`

install BetterDiscord

Type: boolean

Default: false

Example: true

`my-dotfiles.discord.enable`

enable Discord config

Type: boolean

Default: false

Example: true

`my-dotfiles.discord.source`

the installation source for Discord

Type: lib.types.enum [ "flatpak" ]

Default: "flatpak"

`my-dotfiles.discord.supported`

whether Discord is supported on the current platform

Type: lib.types.bool

Default: pkgs.stdenv.hostPlatform.isLinux

`my-dotfiles.ets.enable`

install and configure ets

Type: boolean

Default: false

Example: true

`my-dotfiles.eza.enable`

install and configure eza as a replacement for ls

Type: boolean

Default: false

Example: true

`my-dotfiles.eza.enableAliases`

Enable shell aliases.

Type: lib.types.bool

Default: true

`my-dotfiles.eza.theme`

the theme to use

Type: lib.types.enum themes.all

Default: "base16"

`my-dotfiles.fd.enable`

install and configure fd

Type: boolean

Default: false

Example: true

`my-dotfiles.fd.ignoreGitRepoFiles`

Ignore files inside .git

Type: lib.types.bool

Default: true

`my-dotfiles.fd.ignoreMacFiles`

Ignore system files created by MacOS.

Type: lib.types.bool

Default: pkgs.stdenv.hostPlatform.isDarwin

`my-dotfiles.fish.enable`

install and configure fish

Type: boolean

Default: false

Example: true

`my-dotfiles.fish.fixPATH`

fix the PATH variable on login

Type: lib.types.bool

Default: pkgs.stdenv.hostPlatform.isDarwin

`my-dotfiles.fish.isSHELL`

use as $SHELL

Type: boolean

Default: false

Example: true

`my-dotfiles.fzf.enable`

install and configure fzf

Type: boolean

Default: false

Example: true

`my-dotfiles.git.enable`

install and configure git

Type: boolean

Default: false

Example: true

`my-dotfiles.git.fzf.fixup`

Add git fixup command

Type: lib.types.bool

Default: false

`my-dotfiles.git.github-actions`

install the act command-line tool for locally running GitHub Actions

Type: boolean

Default: false

Example: true

`my-dotfiles.git.ignoreMacFiles`

Ignore system files created by MacOS.

Type: lib.types.bool

Default: pkgs.stdenv.hostPlatform.isDarwin

`my-dotfiles.git.inPrompt`

show git info in the shell prompt

Type: boolean

Default: false

Example: true

`my-dotfiles.git.useDelta`

Use delta to show diffs.

Type: lib.types.bool

Default: true

`my-dotfiles.git.useDyff`

Use dyff to show diffs between YAML files.

Type: lib.types.bool

Default: true

`my-dotfiles.github-act.containerArchitecture`

the container architecture to use for runners

Type: lib.types.str

Default: ""

Example: "linux/amd64"

`my-dotfiles.github-act.enable`

install and configure act, the local GitHub Actions runner

Type: boolean

Default: false

Example: true

`my-dotfiles.github-act.extraConfig`

extra values to add to .actrc

Type: lib.types.lines

Default: ""

`my-dotfiles.github-act.githubEnterpriseHostname`

the hostname of the GitHub Enterprise instance, if using one

Type: lib.types.str

Default: ""

Example: "github.my-company.com"

`my-dotfiles.github-act.package`

the act package to install

Type: lib.types.package

Default: pkgs.act

`my-dotfiles.github-act.runnerImages`

the available runners (platforms) and their Docker images

Type: lib.types.attrsOf (lib.types.str)

Default: { }

Example:

{
  "ubuntu-18.04" = "nektos/act-environments-ubuntu:18.04";
}

`my-dotfiles.github-cli.enable`

install and configure the github CLI tool

Type: boolean

Default: false

Example: true

`my-dotfiles.github-cli.stack.enable`

install the stack extension

Type: lib.types.bool

Default: true

`my-dotfiles.global.colorscheme`

The general color scheme used throughout various programs.

Type:

types.enum [
  "dark"
  "light"
  "auto"
]

Default: "auto"

`my-dotfiles.global.font-category.code`

the monospace font family used for displaying code.

Type: fontType

Default:

{
  package = pkgs.nerd-fonts.jetbrains-mono;
  family-name = "JetBrainsMonoNL Nerd Font";
}

`my-dotfiles.global.font-category.terminal`

the monospace font family used for the terminal.

Type: fontType

Default: config.my-dotfiles.global.font-category.code

`my-dotfiles.global.nerdfonts`

NerdFonts are supported and installed

Type: boolean

Default: false

Example: true

`my-dotfiles.glow.enable`

install glow

Type: boolean

Default: false

Example: true

`my-dotfiles.glow.theme`

the theme to use

Type: lib.types.enum (themes.all)

Default: "base16"

`my-dotfiles.kubectl.alias.ls.enable`

alias to list resources by name

Type: lib.types.bool

Default: false

`my-dotfiles.kubectl.color.enable`

use kubecolor for kubectl output

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.color.package`

the kubecolor package to install

Type: lib.types.package

Default: pkgs.kubecolor

`my-dotfiles.kubectl.enable`

install kubectl

Type: boolean

Default: false

Example: true

`my-dotfiles.kubectl.extensions.klock.enable`

install kubectl-klock

Type: boolean

Default: false

Example: true

`my-dotfiles.kubectl.extensions.klock.package`

the kubectl-klock package to install

Type: lib.types.package

Default: pkgs.kubectl-klock

`my-dotfiles.kubectl.extraAliases`

extra kubectl aliases to add to the kuberc file

Type: lib.types.attrsOf kuberc.types.aliasOverride

Default: { }

Example:

{
  gety = {
    command = "get";
    options = {
      output = {
        default = "yaml";
      };
    };
  };
}

`my-dotfiles.kubectl.extraDefaults`

extra default option overrides for specific kubectl subcommands

Type: lib.types.attrsOf kuberc.types.commandDefaults

Default: { }

Example:

{
  apply = {
    options = {
      server-side = {
        default = "true";
      };
    };
  };
}

`my-dotfiles.kubectl.package`

the kubectl package to install

Type: lib.types.package

Default: pkgs.kubectl

`my-dotfiles.kubectl.serverSideApply`

use server-side apply by default

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.shellAliases.alias.k.enable`

enable the k alias

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.shellAliases.alias.k.to`

the command to alias for the k alias

Type: lib.types.str

Default: "kubectl"

`my-dotfiles.kubectl.shellAliases.alias.kd.enable`

enable the kd alias

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.shellAliases.alias.kd.to`

the command to alias for the kd alias

Type: lib.types.str

Default: "kubectl describe"

`my-dotfiles.kubectl.shellAliases.alias.kg.enable`

enable the kg alias

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.shellAliases.alias.kg.to`

the command to alias for the kg alias

Type: lib.types.str

Default: "kubectl get"

`my-dotfiles.kubectl.shellAliases.alias.kgo.enable`

enable the kgo alias

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.shellAliases.alias.kgo.to`

the command to alias for the kgo alias

Type: lib.types.str

Default: "kubectl get -oyaml"

`my-dotfiles.kubectl.shellAliases.alias.klog.enable`

enable the klog alias

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.shellAliases.alias.klog.to`

the command to alias for the klog alias

Type: lib.types.str

Default: "kubectl logs"

`my-dotfiles.kubectl.shellAliases.alias.kwatch.enable`

enable the kwatch alias

Type: lib.types.bool

Default: true

`my-dotfiles.kubectl.shellAliases.alias.kwatch.to`

the command to alias for the kwatch alias

Type: lib.types.str

Default: "kubectl watch"

`my-dotfiles.kubectl.shellAliases.enable`

add shell aliases and abbreviations for kubectl commands

Type: lib.types.bool

Default: true

`my-dotfiles.kubesel.enable`

install kubesel

Type: boolean

Default: false

Example: true

`my-dotfiles.kubesel.enableFishAliases`

add fish shell aliases and abbreviations for kubesel commands

Type: lib.types.bool

Default: cfg.enableShellAliases

`my-dotfiles.kubesel.enableShellAliases`

add shell aliases and abbreviations for kubesel commands

Type: lib.types.bool

Default: true

`my-dotfiles.kubesel.inPrompt`

show kubesel info in the shell prompt

Type: boolean

Default: false

Example: true

`my-dotfiles.kubesel.inPromptClusterOverrides`

override the name or color for specific clusters

Type: lib.types.attrs

Default: { }

Example:

{
  "docker-desktop" = {
    name = "docker";
    fg = "#FFFFFF";
    bg = "#1D63ED";
  };
}

`my-dotfiles.kubesel.kubeconfigs`

glob pattern matching kubeconfig files

Type: lib.types.nullOr lib.types.str

Default: null

Example: "~/.kube/configs/*.yaml"

`my-dotfiles.kubesel.package`

the kubesel package to install

Type: lib.types.package

Default: pkgs.kubesel

`my-dotfiles.lf.enable`

install and configure lf

Type: boolean

Default: false

Example: true

`my-dotfiles.neovim.colorschemes.dark`

The colorscheme used for dark mode.

Type: lib.types.str

Default: "monokai-pro"

`my-dotfiles.neovim.colorschemes.light`

The colorscheme used for light mode.

Type: lib.types.str

Default: "catppuccin-latte"

`my-dotfiles.neovim.editor.rulers`

Column numbers to draw a ruler at.

Type: lib.types.listOf lib.types.int

Default:

`my-dotfiles.neovim.enable`

neovim

Type: boolean

Default: false

Example: true

`my-dotfiles.neovim.integrations.git`

Enable git integrations.

Type: lib.types.bool

Default: config.programs.git.enable

`my-dotfiles.neovim.integrations.xxd`

Enable hex editing with xxd.

Type: lib.types.bool

Default: false

`my-dotfiles.neovim.keymap.help`

Display the keymap after a short delay.

Type: lib.types.nullOr lib.types.bool

Default: true

`my-dotfiles.neovim.keymap.leader`

Change the key.

Type: lib.types.nullOr lib.types.str

Default: "<Space>"

`my-dotfiles.neovim.shellAliases.cvim`

Create cvim alias for using neovim as a pager.

Type: lib.types.bool

Default: false

`my-dotfiles.neovim.shellAliases.yvim`

Create yvim alias for using neovim as YAML pager.

Type: lib.types.bool

Default: false

`my-dotfiles.neovim.syntax.nix`

Enable nix syntax support (treesitter).

Type: lib.types.bool

Default: false

`my-dotfiles.neovim.syntax.yaml`

Enable yaml syntax support (treesitter).

Type: lib.types.bool

Default: false

`my-dotfiles.neovim.ui.focus_dimming`

Dim unfocused panes.

Type: lib.types.bool

Default: true

`my-dotfiles.neovim.ui.nerdfonts`

Enable support for using Nerdfonts.

Type: lib.types.bool

Default: cfgGlobal.nerdfonts

`my-dotfiles.neovim.ui.transparent_background`

Use a transparent background.

Type: lib.types.bool

Default: false

`my-dotfiles.oh-my-posh.enable`

install and configure oh-my-posh

Type: boolean

Default: false

Example: true

`my-dotfiles.oh-my-posh.enableFishIntegration`

use oh-my-posh on fish

Type: lib.types.bool

Default: true

`my-dotfiles.oh-my-posh.envAnnotations`

Type: lib.types.attrsOf lib.types.attrs

Default: { }

Example:

{
  something = {
    style = "diamond";
    leading_diamond = " ";
    trailing_diamond = "";
    type = "text";
    background = "red";
    template = " foo ";
  };
}

`my-dotfiles.oh-my-posh.extraBlocks`

Type: lib.types.attrsOf lib.types.attrs

Default: { }

`my-dotfiles.oh-my-posh.newline`

user text is entered on a new line

Type: lib.types.bool

Default: true

`my-dotfiles.oh-my-posh.pathAnnotations`

Type: lib.types.attrsOf lib.types.attrs

Default: { }

Example:

{
  something = {
    style = "diamond";
    leading_diamond = " ";
    trailing_diamond = "";
    type = "text";
    background = "red";
    template = " foo ";
  };
}

`my-dotfiles.oh-my-posh.streaming.enable`

render slow prompt segments in the background

Type: boolean

Default: false

Example: true

`my-dotfiles.oh-my-posh.streaming.timeout`

max time to wait before showing the incomplete prompt

Type: lib.types.int

Default: 100

`my-dotfiles.ranger.enable`

install and configure ranger

Type: boolean

Default: false

Example: true

`my-dotfiles.ranger.glow.forOpen`

use glow to open markdown files

Type: boolean

Default: false

Example: true

`my-dotfiles.ranger.glow.forPreview`

use glow to preview markdown files

Type: boolean

Default: false

Example: true

`my-dotfiles.ripgrep.enable`

install ripgrep

Type: boolean

Default: false

Example: true

`my-dotfiles.vicinae.enable`

install vicinae

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.bookmarks.enable`

add bookmark support

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.colorscheme`

The color scheme used for Visual Studio Code.

Type:

lib.types.enum [
  "dark"
  "light"
  "auto"
]

Default: config.my-dotfiles.global.colorscheme

`my-dotfiles.vscode.config.allowedLinkSchemes.extras`

Extra hyperlink schemes that are allowed to be opened.

Type: lib.types.listOf lib.types.str

Default: [ ]

`my-dotfiles.vscode.config.allowedLinkSchemes.includeDefaults`

Include the default hyperlink schemes that are allowed to be opened.

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.copilot.enable`

add GitHub Copilot to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.dependencies.packages`

Extra packages to install.

Type: my-dotfiles.lib.types.functionListTo lib.types.package

Default: (pkgs: [ ])

Example:

(
  pkgs: with pkgs; [
    gcc
    rustc
  ]
)

`my-dotfiles.vscode.dependencies.unfreePackages`

Unfree packages to allow.

Type: lib.types.listOf lib.types.str

Default: [ ]

Example: [ "vscode-extension-ms-vscode-remote-remote-ssh" ]

`my-dotfiles.vscode.devcontainers.enable`

add support for running VS Code in dev containers

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.devenv.enable`

add devenv support

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.editor.rulers`

Column numbers to draw a ruler at.

Type: lib.types.listOf lib.types.int

Default:

`my-dotfiles.vscode.editor.whitespace.showTrailing`

Highlight trailing whitespace.

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.enable`

install and configure Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.fhs.enabled`

Use a FHS environment for VS Code.

Type: lib.types.bool

Default: false

`my-dotfiles.vscode.github.enable`

add GitHub-centric extensions

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.keymap.bind-cw`

Map Ctrl-W to control panes and focus

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.keymap.bindings`

custom keybindings

Type: lib.types.listOf vscode.types.keybind

Default: [ ]

`my-dotfiles.vscode.keymap.help.enable`

show a help menu for multi-key key bindings

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.keymap.style`

use alternate keybindings

Type:

lib.types.enum [
  "default"
  "intellij"
]

Default: "default"

`my-dotfiles.vscode.kubernetes.enable`

add Kubernetes-centric extensions

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.bash.enable`

add Bash language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.bash.shellcheck.package`

the shellcheck package

Type: lib.types.package

Default: pkgs.shellcheck

`my-dotfiles.vscode.language.go.compiler.package`

the Go compiler package

Type: any

Default: pkgs.go

`my-dotfiles.vscode.language.go.debugger.enable`

install the Go debugger, dlv

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.language.go.debugger.package`

the dlv package

Type: any

Default: pkgs.delve

`my-dotfiles.vscode.language.go.enable`

add Go language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.go.linter.enable`

install golangci-lint for linting Go source code

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.language.go.linter.package`

the golangci-lint package

Type: any

Default: pkgs.golangci-lint

`my-dotfiles.vscode.language.go.lsp.enable`

install the Go language server, gopls

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.language.go.lsp.package`

the gopls package

Type: any

Default: pkgs.gopls

`my-dotfiles.vscode.language.go.snippets.general`

add snippets for general language features

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.language.makefile.enable`

add Makefile language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.makefile.showWhitespace`

Show boundary whitespace in Makefiles.

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.language.nix.enable`

add Nix language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.nix.formatter`

the formatter to use for Nix files

Type: lib.types.enum [ "nixfmt" ]

Default: "nixfmt"

`my-dotfiles.vscode.language.nix.lsp.enable`

use a Language Server for Nix language support

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.language.python.enable`

add python language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.rust.enable`

add Rust language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.rust.lsp.enable`

install the Rust language server, rust-analyzer

Type: lib.types.bool

Default: true

`my-dotfiles.vscode.language.rust.lsp.package`

the rust-analyzer package

Type: any

Default: pkgs.rust-analyzer

`my-dotfiles.vscode.language.toml.enable`

add TOML language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.language.yaml.enable`

add Yaml language support to Visual Studio Code

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.onlyConfigure`

do not install Visual Studio Code, only configure it

Type: boolean

Default: false

Example: true

`my-dotfiles.vscode.todos.enable`

improve TODO support

Type: boolean

Default: false

Example: true

`my-dotfiles.yq.enable`

install and configure yq

Type: boolean

Default: false

Example: true

`my-dotfiles.zoxide.enable`

install and configure zoxide

Type: boolean

Default: false

Example: true

Generated with nix-options-doc

FilesExpand file tree

OPTIONS.md

Latest commit

History

OPTIONS.md

File metadata and controls

NixOS Module Options