Zsh

`programs.zsh.autosuggestions.async`

Whether to fetch suggestions asynchronously Type: boolean

Default

true

Example

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-autosuggestions.nix

`programs.zsh.autosuggestions.enable`

Whether to enable zsh-autosuggestions. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-autosuggestions.nix

`programs.zsh.autosuggestions.extraConfig`

Attribute set with additional configuration values Type: attribute set of string

Default

{ }

Example

{"ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" = "20";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-autosuggestions.nix

`programs.zsh.autosuggestions.highlightStyle`

Highlight style for suggestions ({fore,back}ground color) Type: string

Default

"fg=8"

Example

"fg=cyan"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-autosuggestions.nix

`programs.zsh.autosuggestions.strategy`

ZSH_AUTOSUGGEST_STRATEGY is an array that specifies how suggestions should be generated. The strategies in the array are tried successively until a suggestion is found. There are currently three built-in strategies to choose from:

history: Chooses the most recent match from history.
completion: Chooses a suggestion based on what tab-completion would suggest. (requires zpty module)
match_prev_cmd: Like history, but chooses the most recent match whose preceding history item matches the most recently executed command. Note that this strategy won't work as expected with ZSH options that don't preserve the history order such as HIST_IGNORE_ALL_DUPS or HIST_EXPIRE_DUPS_FIRST.

Type: list of (one of "history", "completion", "match_prev_cmd")

Default

["history"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-autosuggestions.nix

`programs.zsh.enable`

Whether to configure zsh as an interactive shell. To enable zsh for a particular user, use the {option}users.users.<name?>.shell option for that user. To enable zsh system-wide use the {option}users.defaultUserShell option.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.enableBashCompletion`

Enable compatibility with bash's programmable completion system.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.enableCompletion`

Enable zsh completion for all interactive zsh shells.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.enableGlobalCompInit`

Enable execution of compinit call for all interactive zsh shells.

This option can be disabled if the user wants to extend its fpath and a custom compinit call in the local config is required.

Type: boolean

Default

config.programs.zsh.enableCompletion

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.enableLsColors`

Enable extra colors in directory listings (used by ls and tree).

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.histFile`

Change history file.

Type: string

Default

"$HOME/.zsh_history"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.histSize`

Change history size.

Type: signed integer

Default

2000

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.interactiveShellInit`

Shell script code called during interactive zsh shell initialisation.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.loginShellInit`

Shell script code called during zsh login shell initialisation.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.ohMyZsh.cacheDir`

Cache directory to be used by oh-my-zsh. Without this option it would default to the read-only nix store.

Type: string

Default

"$HOME/.cache/oh-my-zsh"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/oh-my-zsh.nix

`programs.zsh.ohMyZsh.custom`

Path to a custom oh-my-zsh package to override config of oh-my-zsh. (Can't be used along with customPkgs).

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/oh-my-zsh.nix

`programs.zsh.ohMyZsh.customPkgs`

List of custom packages that should be loaded into oh-my-zsh.

Type: list of package

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/oh-my-zsh.nix

`programs.zsh.ohMyZsh.enable`

Enable oh-my-zsh.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/oh-my-zsh.nix

`programs.zsh.ohMyZsh.package`

The oh-my-zsh package to use. Type: package

Default

pkgs.oh-my-zsh

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/oh-my-zsh.nix

`programs.zsh.ohMyZsh.plugins`

List of oh-my-zsh plugins

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/oh-my-zsh.nix

`programs.zsh.ohMyZsh.theme`

Name of the theme to be used by oh-my-zsh.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/oh-my-zsh.nix

`programs.zsh.promptInit`

Shell script code used to initialise the zsh prompt.

Type: strings concatenated with "\n"

Default

'' # Note that to manually override this in ~/.zshrc you should runprompt off# before setting your PS1 and etc. Otherwise this will likely to interact with # your ~/.zshrc configuration in unexpected ways as the default prompt sets # a lot of different prompt variables. autoload -U promptinit && promptinit && prompt suse && setopt prompt_sp ''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.setOptions`

Configure zsh options. See {manpage}zshoptions(1).

Type: list of string

Default

["HIST_IGNORE_DUPS""SHARE_HISTORY""HIST_FCNTL_LOCK"]

Example

["EXTENDED_HISTORY""RM_STAR_WAIT"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.shellAliases`

Set of aliases for zsh shell, which overrides {option}environment.shellAliases. See {option}environment.shellAliases for an option format description.

Type: attribute set of (null or string or path)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.shellInit`

Shell script code called during zsh shell initialisation.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh.nix

`programs.zsh.syntaxHighlighting.enable`

Whether to enable zsh-syntax-highlighting. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix

`programs.zsh.syntaxHighlighting.highlighters`

Specifies the highlighters to be used by zsh-syntax-highlighting.

The following defined options can be found here: https://github.com/zsh-users/zsh-syntax-highlighting/blob/master/docs/highlighters.md

Type: list of (one of "main", "brackets", "pattern", "cursor", "regexp", "root", "line")

Default

["main"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix

`programs.zsh.syntaxHighlighting.patterns`

Specifies custom patterns to be highlighted by zsh-syntax-highlighting.

Please refer to the docs for more information about the usage: https://github.com/zsh-users/zsh-syntax-highlighting/blob/master/docs/highlighters/pattern.md

Type: attribute set of string

Default

{ }

Example

{"rm -rf *" = "fg=white,bold,bg=red";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix

`programs.zsh.syntaxHighlighting.styles`

Specifies custom styles to be highlighted by zsh-syntax-highlighting.

Please refer to the docs for more information about the usage: https://github.com/zsh-users/zsh-syntax-highlighting/blob/master/docs/highlighters/main.md

Type: attribute set of string

Default

{ }

Example

{"alias" = "fg=magenta,bold";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix

`programs.zsh.vteIntegration`

Whether to enable Zsh integration for VTE terminals. This allows it to preserve the current directory of the shell across terminals.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/config/vte.nix

`programs.zsh.zsh-autoenv.enable`

Whether to enable zsh-autoenv. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-autoenv.nix

`programs.zsh.zsh-autoenv.package`

The zsh-autoenv package to use. Type: package

Default

pkgs.zsh-autoenv

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/programs/zsh/zsh-autoenv.nix