Appendix A. Configuration Options

List of email accounts.

Type: attribute set of submodules

Default: { }

Declared by:

The email address of this account.

Type: string matching the pattern .*@.*

Example: "jane.doe@example.org"

Declared by:

Alternative email addresses of this account.

Type: list of string matching the pattern .*@.*s

Default: [ ]

Example: [ "webmaster@example.org" "admin@example.org" ]

Declared by:

Contact completion configuration as expected per alot. See alot's wiki for explanation about possible values.

Type: attribute set of strings

Default: { command = "'\${pkgs.notmuch}/bin/notmuch address --format=json --output=recipients date:6M..'"; regexp = '''\[?{"name": "(?P<name>.*)", "address": "(?P<email>.+)", "name-addr": ".*"}[,\]]?'''; shellcommand_external_filtering = "False"; type = "shellcommand"; }

Example:

{
  type = "shellcommand";
  command = "abook --mutt-query";
  regexp = "'^(?P<email>[^@]+@[^\t]+)\t+(?P<name>[^\t]+)'";
  ignorecase = "True";
}

Declared by:

Extra settings to add to this Alot account configuration.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Command to send a mail. If msmtp is enabled for the account, then this is set to msmtpq --read-envelope-from --read-recipients.

Type: null or string

Declared by:

Whether to enable Astroid.

Type: boolean

Default: false

Example: true

Declared by:

Extra settings to add to this astroid account configuration.

Type: attribute set of anythings

Default: { }

Example: { select_query = ""; }

Declared by:

Command to send a mail. If msmtp is enabled for the account, then this is set to msmtpq --read-envelope-from --read-recipients.

Type: string

Declared by:

Some email providers have peculiar behavior that require special treatment. This option is therefore intended to indicate the nature of the provider.

When this indicates a specific provider then, for example, the IMAP and SMTP server configuration may be set automatically.

Type: one of "plain", "gmail.com", "runbox.com"

Default: "plain"

Declared by:

Standard email folders.

Type: submodule

Default: { }

Declared by:

Relative path of the drafts mail folder.

Type: string

Default: "Drafts"

Declared by:

Relative path of the inbox mail.

Type: string

Default: "Inbox"

Declared by:

Relative path of the sent mail folder.

Type: null or string

Default: "Sent"

Declared by:

Relative path of the deleted mail folder.

Type: string

Default: "Trash"

Declared by:

Whether to enable the getmail mail retriever for this account.

Type: boolean

Default: false

Example: true

Declared by:

Enable if you want to delete read messages from the server. Most users should either enable delete or disable readAll.

Type: boolean

Default: false

Declared by:

Specify a command delivering the incoming mail to your maildir.

Type: null or string

Default: null

Example: "\${pkgs.maildrop}/bin/maildrop"

Declared by:

A non-empty list of mailboxes. To download all mail you can use the ALL mailbox.

Type: non-empty list of strings

Default: [ ]

Example: [ "INBOX" "INBOX.spam" ]

Declared by:

Enable if you want to fetch all, even the read messages from the server. Most users should either enable delete or disable readAll.

Type: boolean

Default: true

Declared by:

GPG configuration.

Type: null or submodule

Default: null

Declared by:

Encrypt outgoing messages by default.

Type: boolean

Default: false

Declared by:

The key to use as listed in gpg --list-keys.

Type: string

Declared by:

Sign messages by default.

Type: boolean

Default: false

Declared by:

The IMAP configuration to use for this account.

Type: null or submodule

Default: null

Declared by:

Hostname of IMAP server.

Type: string

Example: "imap.example.org"

Declared by:

The port on which the IMAP server listens. If null then the default port is used.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Example: 993

Declared by:

Configuration for secure connections.

Type: submodule

Default: { }

Declared by:

Whether to enable TLS/SSL.

Type: boolean

Default: true

Declared by:

Path to file containing certificate authorities that should be used to validate the connection authenticity. If null then the system default is used. Note, if set then the system default may still be accepted.

Type: path

Default: "config.accounts.email.certificatesFile"

Declared by:

Whether to use STARTTLS.

Type: boolean

Default: false

Declared by:

Whether to enable imapnotify.

Type: boolean

Default: false

Example: true

Declared by:

IMAP folders to watch.

Type: list of strings

Default: [ ]

Example: [ "Inbox" "[Gmail]/MyLabel" ]

Declared by:

Shell commands to run on any event.

Type: string or attribute set of strings

Default: ""

Example: "\${pkgs.isync}/bin/mbsync test-%s"

Declared by:

Shell commands to run after onNotify event.

Type: string or attribute set of strings

Default: ""

Example: { mail = "\${pkgs.notmuch}/bin/notmuch new && \${pkgs.libnotify}/bin/notify-send 'New mail arrived'"; }

Declared by:

Whether to enable lieer Gmail synchronization for notmuch.

Type: boolean

Default: false

Example: true

Declared by:

Allow missing labels on the Gmail side to be dropped.

Type: boolean

Default: false

Declared by:

Set custom tags to ignore when syncing from local to remote (after translations).

Type: list of strings

Default: [ ]

Declared by:

Set custom tags to ignore when syncing from remote to local (before translations).

Type: list of strings

Default: [ "CATEGORY_FORUMS" "CATEGORY_PROMOTIONS" "CATEGORY_UPDATES" "CATEGORY_SOCIAL" "CATEGORY_PERSONAL" ]

Declared by:

Warn if Notmuch is not also enabled for this account.

This can safely be disabled if notmuch init has been used to configure this account outside of Home Manager.

Type: boolean

Default: true

Declared by:

Replace '/' with '.' in Gmail labels.

Type: boolean

Default: false

Declared by:

Whether to enable lieer synchronization service.

Type: boolean

Default: false

Example: true

Declared by:

How often to synchronize the account.

This value is passed to the systemd timer configuration as the onCalendar option. See systemd.time(7) for more information about the format.

Type: string

Default: "*:0/5"

Declared by:

HTTP timeout in seconds. 0 means forever or system timeout.

Type: unsigned integer, meaning >=0

Default: 0

Declared by:

Maildir configuration for this account.

Type: null or submodule

Default: { path = "\${name}"; }

Declared by:

Path to maildir directory where mail for this account is stored. This is relative to the base maildir path.

Type: string

Declared by:

Whether to enable synchronization using mbsync.

Type: boolean

Default: false

Example: true

Declared by:

Automatically create missing mailboxes within the given mail store.

Type: one of "none", "maildir", "imap", "both"

Default: "none"

Example: "maildir"

Declared by:

Permanently remove messages marked for deletion from the given mail store.

Type: one of "none", "maildir", "imap", "both"

Default: "none"

Example: "both"

Declared by:

Account section extra configuration.

Type: attribute set of string or signed integer or booleans

Default: { }

Example:

{
  PipelineDepth = 10;
  Timeout = 60;
};

Declared by:

Per channel extra configuration.

Type: attribute set of string or signed integer or booleans

Default: { }

Example:

{
  MaxMessages = 10000;
  MaxSize = "1m";
};

Declared by:

Local store extra configuration.

Type: attribute set of string or signed integer or booleans

Default: { }

Declared by:

Remote store extra configuration.

Type: attribute set of string or signed integer or booleans

Default: { }

Declared by:

If set, flattens the hierarchy within the maildir by substituting the canonical hierarchy delimiter / with this value.

Type: null or string

Default: null

Example: "."

Declared by:

Some email providers (Gmail) have a different directory hierarchy for synchronized email messages. Namely, when using mbsync without specifying a set of channels into a group, all synchronized directories end up beneath the [Gmail]/ directory.

This option allows you to specify a group, and subsequently channels that will allow you to sync your mail into an arbitrary hierarchy.

Type: attribute set of submodules

Default: { }

Declared by:

List of channels that should be grouped together into this group. When performing a synchronization, the groups are synchronized, rather than the individual channels.

Using these channels and then grouping them together allows for you to define the maildir hierarchy as you see fit.

Type: attribute set of submodules

Default: { }

Declared by:

Extra configuration lines to add to THIS channel's configuration.

Type: attribute set of string or signed integer or booleans

Default: { }

Example:

''
{
  Create = "both";
  CopyArrivalDate = "yes";
  MaxMessages = 10000;
  MaxSize = "1m";
}
''

Declared by:

IMAP4 patterns for which mailboxes on the remote mail server to sync. If Patterns are specified, masterPattern is interpreted as a prefix which is not matched against the patterns, and is not affected by mailbox list overrides.

If this is left as the default, then mbsync will default to the pattern INBOX.

Type: string

Default: ""

Example: "[Gmail]/Sent Mail"

Declared by:

The unique name for THIS channel in THIS group. The group will refer to this channel by this name.

In addition, you can manually sync just this channel by specifying this name to mbsync on the command line.

Type: string (read only)

Default: "‹name›"

Declared by:

Instead of synchronizing just the mailboxes that match the masterPattern, use it as a prefix which is not matched against the patterns, and is not affected by mailbox list overrides.

Type: list of strings

Default: [ ]

Example: [ "INBOX" ]

Declared by:

Name for where mail coming from the master mail server will end up locally. The mailbox specified by the master's pattern will be placed in this directory.

If this is left as the default, then mbsync will default to the pattern INBOX.

Type: string

Default: ""

Example: "Sent"

Declared by:

The name of this group for this account. These names are different than some others, because they will hide channel names that are the same.

Type: string (read only)

Default: "‹name›"

Declared by:

Pattern of mailboxes to synchronize.

Type: list of strings

Default: [ "*" ]

Declared by:

Propagate mailbox deletions to the given mail store.

Type: one of "none", "maildir", "imap", "both"

Default: "none"

Example: "imap"

Declared by:

The on-disk folder naming style. This option has no effect when flatten is used.

Type: one of "Verbatim", "Maildir++", "Legacy"

Default: "Verbatim"

Example: "Maildir++"

Declared by:

Whether to enable msmtp.

If enabled then it is possible to use the --account command line option to send a message for a given account using the msmtp or msmtpq tool. For example, msmtp --account=private would send using the account defined in accounts.email.accounts.private. If the --account option is not given then the primary account will be used.

Type: boolean

Default: false

Declared by:

Extra configuration options to add to ~/.msmtprc. See https://marlam.de/msmtp/msmtprc.txt for examples.

Type: attribute set of strings

Default: { }

Example: { auth = "login"; }

Declared by:

Fingerprint of a trusted TLS certificate. The fingerprint can be obtained by executing msmtp --serverinfo --tls --tls-certcheck=off.

Type: null or string matching the pattern ([[:alnum:]]{2}:)+[[:alnum:]]{2}

Default: null

Example: "my:SH:a2:56:ha:sh"

Declared by:

Whether to enable mu indexing.

Type: boolean

Default: false

Example: true

Declared by:

Unique identifier of the account. This is set to the attribute name of the account configuration.

Type: string (read only)

Declared by:

Whether to enable NeoMutt.

Type: boolean

Default: false

Example: true

Declared by:

Extra lines to add to the folder hook for this account.

Type: strings concatenated with "\n"

Default: ""

Example: "color status cyan default"

Declared by:

Command to send a mail. If not set, neomutt will be in charge of sending mails.

Type: null or string

Default: if config.msmtp.enable then "msmtpq --read-envelope-from --read-recipients" else null

Example: "msmtpq --read-envelope-from --read-recipients"

Declared by:

Whether to enable notmuch indexing.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable OfflineIMAP.

Type: boolean

Default: false

Example: true

Declared by:

Extra configuration options to add to the account section.

Type: attribute set of string or signed integer or booleans

Default: { }

Example: { autorefresh = 20; }

Declared by:

Extra configuration options to add to the local account section.

Type: attribute set of string or signed integer or booleans

Default: { }

Example: { sync_deletes = true; }

Declared by:

Extra configuration options to add to the remote account section.

Type: attribute set of string or signed integer or booleans

Default: { }

Example: { expunge = false; maxconnections = 2; }

Declared by:

Command to run after fetching new mails.

Type: strings concatenated with "\n"

Default: ""

Declared by:

A command, which when run writes the account password on standard output.

Type: null or string or list of strings

Default: null

Example: "secret-tool lookup email me@example.org"

Declared by:

Whether this is the primary account. Only one account may be set as primary.

Type: boolean

Default: false

Declared by:

Name displayed when sending mails.

Type: string

Example: "Jane Doe"

Declared by:

Signature configuration.

Type: submodule

Default: { }

Declared by:

Method to communicate the signature.

Type: one of "append", "attach", "none"

Default: "none"

Declared by:

Signature content.

Type: string

Default: ""

Example:

''
--
Luke Skywalker
May the force be with you.
''

Declared by:

The SMTP configuration to use for this account.

Type: null or submodule

Default: null

Declared by:

Hostname of SMTP server.

Type: string

Example: "smtp.example.org"

Declared by:

The port on which the SMTP server listens. If null then the default port is used.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Example: 465

Declared by:

Configuration for secure connections.

Type: submodule

Default: { }

Declared by:

Whether to enable TLS/SSL.

Type: boolean

Default: true

Declared by:

Path to file containing certificate authorities that should be used to validate the connection authenticity. If null then the system default is used. Note, if set then the system default may still be accepted.

Type: path

Default: "config.accounts.email.certificatesFile"

Declared by:

Whether to use STARTTLS.

Type: boolean

Default: false

Declared by:

The server username of this account. This will be used as the SMTP and IMAP user name.

Type: null or string

Default: null

Declared by:

Path to default file containing certificate authorities that should be used to validate the connection authenticity. This path may be overridden on a per-account basis.

Type: path

Default: "/etc/ssl/certs/ca-certificates.crt"

Declared by:

The base directory for account maildir directories. May be a relative path, in which case it is relative the home directory.

Type: string

Default: "\$HOME/Maildir"

Declared by:

Settings to write to the dconf configuration system.

Type: attribute set of attribute set of GVariant valuess

Default: { }

Example:

{
  "org/gnome/calculator" = {
    button-mode = "programming";
    show-thousands = true;
    base = 10;
    word-size = 64;
    window-position = lib.hm.gvariant.mkTuple [100 100];
  };
}

Declared by:

Whether to enable fontconfig configuration. This will, for example, allow fontconfig to discover fonts and configurations installed through home.packages and nix-env.

Type: boolean

Default: false

Declared by:

Whether to enable GTK 2/3 configuration.

Type: boolean

Default: false

Example: true

Declared by:

The font to use in GTK+ 2/3 applications.

Type: null or submodule

Default: null

Declared by:

Package providing the font. This package will be installed to your profile. If null then the font is assumed to already be available in your profile.

Type: null or package

Default: null

Example:

pkgs.dejavu_fonts

Declared by:

The family name of the font within the package.

Type: string

Example: "DejaVu Sans"

Declared by:

The size of the font.

Type: null or signed integer

Default: null

Example: "8"

Declared by:

The location to put the GTK configuration file.

Type: path

Default: "${config.home.homeDirectory}/.gtkrc-2.0"

Example:

"${config.xdg.configHome}/gtk-2.0/gtkrc"

Declared by:

Extra configuration lines to add verbatim to ~/.gtkrc-2.0.

Type: strings concatenated with "\n"

Default: ""

Example: "gtk-can-change-accels = 1"

Declared by:

Bookmarks in the sidebar of the GTK file browser

Type: list of strings

Default: [ ]

Example: [ "file:///home/jane/Documents" ]

Declared by:

Extra configuration options to add to ~/.config/gtk-3.0/settings.ini.

Type: attribute set of boolean or signed integer or strings

Default: { }

Example: { gtk-cursor-blink = false; gtk-recent-files-limit = 20; }

Declared by:

Extra configuration lines to add verbatim to ~/.config/gtk-3.0/gtk.css.

Type: strings concatenated with "\n"

Default: ""

Declared by:

The icon theme to use.

Type: null or submodule

Default: null

Declared by:

Package providing the theme. This package will be installed to your profile. If null then the theme is assumed to already be available in your profile.

Type: null or package

Default: null

Example:

pkgs.gnome3.gnome_themes_standard

Declared by:

The name of the theme within the package.

Type: string

Example: "Adwaita"

Declared by:

The GTK+2/3 theme to use.

Type: null or submodule

Default: null

Declared by:

Package providing the theme. This package will be installed to your profile. If null then the theme is assumed to already be available in your profile.

Type: null or package

Default: null

Example:

pkgs.gnome3.gnome_themes_standard

Declared by:

The name of the theme within the package.

Type: string

Example: "Adwaita"

Declared by:

Some Nix-packages provide debug symbols for gdb in the debug-output. This option ensures that those are automatically fetched from the binary cache if available and gdb is configured to find those symbols.

Type: boolean

Default: false

Example: true

Declared by:

The set of packages to appear in the user environment.

Type: list of packages

Default: [ ]

Declared by:

The activation scripts blocks to run when activating a Home Manager generation. Any entry here should be idempotent, meaning running twice or more times produces the same result as running it once.

If the script block produces any observable side effect, such as writing or deleting files, then it must be placed after the special writeBoundary script block. Prior to the write boundary one can place script blocks that verifies, but does not modify, the state of the system and exits if an unexpected state is found. For example, the checkLinkTargets script block checks for collisions between non-managed files and files defined in home.file.

A script block should respect the DRY_RUN variable, if it is set then the actions taken by the script should be logged to standard out and not actually performed. The variable DRY_RUN_CMD is set to echo if dry run is enabled.

A script block should also respect the VERBOSE variable, and if set print information on standard out that may be useful for debugging any issue that may arise. The variable VERBOSE_ARG is set to --verbose if verbose output is enabled.

Type: DAG of strings

Default: { }

Example:

{
  myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] ''
    $DRY_RUN_CMD ln -s $VERBOSE_ARG \
        ${builtins.toPath ./link-me-directly} $HOME
  '';
}

Declared by:

List of additional package outputs of the packages home.packages that should be installed into the user environment.

Type: list of strings

Default: [ ]

Example: [ "doc" "info" "devdoc" ]

Declared by:

Attribute set of files to link into the user home.

Type: attribute set of submodules

Default: { }

Declared by:

Set the execute bit. If null, defaults to the mode of the source file or to false for files created through the text option.

Type: null or boolean

Default: null

Declared by:

Shell commands to run when file has changed between generations. The script will be run after the new files have been linked into place.

Type: strings concatenated with "\n"

Default: ""

Declared by:

If the file source is a directory, then this option determines whether the directory should be recursively linked to the target location. This option has no effect if the source is a file.

If false (the default) then the target will be a symbolic link to the source directory. If true then the target will be a directory structure matching the source's but whose leafs are symbolic links to the files of the source directory.

Type: boolean

Default: false

Declared by:

Path of the source file or directory. If home.file.<name?>.text is non-null then this option will automatically point to a file containing that text.

Type: path

Declared by:

Path to target file relative to HOME.

Type: string

Default: <name>

Declared by:

Text of the file. If this option is null then home.file.<name?>.source must be set.

Type: null or strings concatenated with "\n"

Default: null

Declared by:

The user's home directory. Must be an absolute path.

Type: path

Default: "$HOME" for state version < 20.09, undefined for state version ≥ 20.09

Example: "/home/jane.doe"

Declared by:

Keyboard configuration. Set to null to disable Home Manager keyboard management.

Type: null or submodule

Default: { }

Declared by:

Keyboard layout. If null, then the system configuration will be used.

This defaults to null for state version ≥ 19.09 and "us" otherwise.

Type: null or string

Default: null

Declared by:

Keyboard model.

Type: null or string

Default: null

Example: "presario"

Declared by:

X keyboard options; layout switching goes here.

Type: list of strings

Default: [ ]

Example: [ "grp:caps_toggle" "grp_led:scroll" ]

Declared by:

X keyboard variant. If null, then the system configuration will be used.

This defaults to null for state version ≥ 19.09 and "" otherwise.

Type: null or string

Default: null

Example: "colemak"

Declared by:

Language configuration.

Type: submodule

Default: { }

Declared by:

The language to use for addresses.

Type: null or string

Default: null

Declared by:

The language to use unless overridden by a more specific option.

Type: null or string

Default: null

Declared by:

The language to use for collation (alphabetical ordering).

Type: null or string

Default: null

Declared by:

Character classification category.

Type: null or string

Default: null

Declared by:

The language to use for measurement values.

Type: null or string

Default: null

Declared by:

The language to use for messages, application UI languages, etc.

Type: null or string

Default: null

Declared by:

The language to use for formatting currencies and money amounts.

Type: null or string

Default: null

Declared by:

The language to use for personal names.

Type: null or string

Default: null

Declared by:

The language to use for numerical values.

Type: null or string

Default: null

Declared by:

The language to use for paper sizes.

Type: null or string

Default: null

Declared by:

The language to use for telephone numbers.

Type: null or string

Default: null

Declared by:

The language to use for formatting times.

Type: null or string

Default: null

Declared by:

Extra directories to add to PATH.

Type: list of strings

Default: [ ]

Example: [ ".git/safe/../../bin" "\${xdg.configHome}/emacs/bin" "~/.local/bin" ]

Declared by:

Environment variables to always set at login.

The values may refer to other environment variables using POSIX.2 style variable references. For example, a variable parameter may be referenced as $parameter or ${parameter}. A default value foo may be given as per ${parameter:-foo} and, similarly, an alternate value bar can be given as per ${parameter:+bar}.

Note, these variables may be set in any order so no session variable may have a runtime dependency on another session variable. In particular code like

home.sessionVariables = {
  FOO = "Hello";
  BAR = "$FOO World!";
};

may not work as expected. If you need to reference another session variable, then do so inside Nix instead. The above example then becomes

home.sessionVariables = {
  FOO = "Hello";
  BAR = "${config.home.sessionVariables.FOO} World!";
};

Type: attribute set

Default: { }

Example: { EDITOR = "emacs"; GS_OPTIONS = "-sPAPERSIZE=a4"; }

Declared by:

It is occasionally necessary for Home Manager to change configuration defaults in a way that is incompatible with stateful data. This could, for example, include switching the default data format or location of a file.

The state version indicates which default settings are in effect and will therefore help avoid breaking program configurations. Switching to a higher state version typically requires performing some manual steps, such as data conversion or moving files.

Type: one of "18.09", "19.03", "19.09", "20.03", "20.09", "21.03", "21.05"

Default: "18.09"

Declared by:

The user's username.

Type: string

Default: "$USER" for state version < 20.09, undefined for state version ≥ 20.09

Example: "jane.doe"

Declared by:

This option allows modules to define helper functions, constants, etc.

Type: attribute set of attribute sets

Default: { }

Declared by:

Whether to install the HTML manual. This also installs the home-manager-help tool, which opens a local copy of the Home Manager manual in the system web browser.

Type: boolean

Default: false

Declared by:

Whether to install a JSON formatted list of all Home Manager options. This can be located at <profile directory>/share/doc/home-manager/options.json, and may be used for navigating definitions, auto-completing, and other miscellaneous tasks.

Type: boolean

Default: false

Example: true

Declared by:

Whether to install the configuration manual page. The manual can be reached by man home-configuration.nix.

When looking at the manual page pretend that all references to NixOS stuff are actually references to Home Manager stuff. Thanks!

Type: boolean

Default: true

Example: false

Declared by:

How unread and relevant news should be presented when running home-manager build and home-manager switch.

The options are

Type: one of "silent", "notify", "show"

Default: "notify"

Declared by:

The configuration of the Nix Packages collection. (For details, see the Nixpkgs documentation.) It allows you to set package configuration options.

If null, then configuration is taken from the fallback location, for example, ~/.config/nixpkgs/config.nix.

Note, this option will not apply outside your Home Manager configuration like when installing manually through nix-env. If you want to apply it both inside and outside Home Manager you can put it in a separate file and include something like

  nixpkgs.config = import ./nixpkgs-config.nix;
  xdg.configFile."nixpkgs/config.nix".source = ./nixpkgs-config.nix;

in your Home Manager configuration.

Type: null or nixpkgs config

Default: null

Example: { allowBroken = true; }

Declared by:

List of overlays to use with the Nix Packages collection. (For details, see the Nixpkgs documentation.) It allows you to override packages globally. This is a function that takes as an argument the original Nixpkgs. The first argument should be used for finding dependencies, and the second should be used for overriding recipes.

If null, then the overlays are taken from the fallback location, for example, ~/.config/nixpkgs/overlays.

Like nixpkgs.config this option only applies within the Home Manager configuration. See nixpkgs.config for a suggested setup that works both internally and externally.

Type: null or list of nixpkgs overlays

Default: null

Example:

[ (self: super: {
    openssh = super.openssh.override {
      hpnSupport = true;
      withKerberos = true;
      kerberos = self.libkrb5;
    };
  };
) ]

Declared by:

Environment variables that will be set for the PAM session. The variable values must be as described in pam_env.conf(5).

Note, this option will become deprecated in the future and its use is therefore discouraged.

Type: attribute set

Default: { }

Example: { EDITOR = "vim"; }

Declared by:

Whether to enable Abook.

Type: boolean

Default: false

Example: true

Declared by:

Extra lines added to $HOME/.config/abook/abookrc. Available configuration options are described in the abook repository: https://sourceforge.net/p/abook/git/ci/master/tree/sample.abookrc.

Type: strings concatenated with "\n"

Default: ""

Example:

''
field pager = Pager
view CONTACT = name, email
set autosave=true
''

Declared by:

Whether to enable the afew initial tagging script for Notmuch.

Type: boolean

Default: false

Example: true

Declared by:

Extra lines added to afew configuration file. Available configuration options are described in the afew manual: https://afew.readthedocs.io/en/latest/configuration.html.

Type: strings concatenated with "\n"

Default:

''
[SpamFilter]
[KillThreadsFilter]
[ListMailsFilter]
[ArchiveSentMailsFilter]
[InboxFilter]
''

Example:

''
[SpamFilter]

[Filter.0]
query = from:pointyheaded@boss.com
tags = -new;+boss
message = Message from above

[InboxFilter]
''

Declared by:

Whether to enable Alacritty.

Type: boolean

Default: false

Example: true

Declared by:

The Alacritty package to install.

Type: package

Default: pkgs.alacritty

Declared by:

Configuration written to ~/.config/alacritty/alacritty.yml. See https://github.com/jwilm/alacritty/blob/master/alacritty.yml for the default configuration.

Type: YAML value

Default: { }

Example:

{
  window.dimensions = {
    lines = 3;
    columns = 200;
  };
  key_bindings = [
    {
      key = "K";
      mods = "Control";
      chars = "\\x0c";
    }
  ];
}

Declared by:

Whether to enable the Alot mail user agent. Alot uses the Notmuch email system and will therefore be automatically enabled for each email account that is managed by Notmuch.

Type: boolean

Default: false

Example: true

Declared by:

Keybindings.

Type: submodule

Default: { }

Declared by:

Bufferlist mode keybindings.

Type: attribute set of strings

Default: { }

Declared by:

Envelope mode keybindings.

Type: attribute set of strings

Default: { }

Declared by:

Global keybindings.

Type: attribute set of strings

Default: { }

Declared by:

Search mode keybindings.

Type: attribute set of strings

Default: { }

Declared by:

Taglist mode keybindings.

Type: attribute set of strings

Default: { }

Declared by:

Thread mode keybindings.

Type: attribute set of strings

Default: { }

Declared by:

Extra lines added to alot configuration file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Content of the hooks file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Configuration options added to alot configuration file.

Type: attribute set of string or signed integer or boolean or floating point numbers

Default: { auto_remove_unread = true; handle_mouse = true; initial_command = "search tag:inbox AND NOT tag:killed"; prefer_plaintext = true; }

Example:

{
  auto_remove_unread = true;
  ask_subject = false;
  thread_indent_replies = 2;
}

Declared by:

How to display the tags.

Type: attribute set of submodules

Default: { }

Declared by:

How to display the tag when focused.

Type: null or string

Default: null

Declared by:

How to display the tag when unfocused. See https://alot.readthedocs.io/en/latest/configuration/theming.html#tagstring-formatting.

Type: null or string

Default: null

Example: "'','', 'white','light red', 'white','#d66'"

Declared by:

Fixed string representation for this tag. The tag can be hidden from view, if the key translated is set to "", the empty string.

Type: null or string

Declared by:

A pair of strings that define a regular substitution to compute the string representation on the fly using re.sub.

Type: null or string

Default: null

Declared by:

Whether to enable aria2.

Type: boolean

Default: false

Example: true

Declared by:

Extra lines added to aria2.conf file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Options to add to aria2.conf file. See aria2c(1) for options.

Type: attribute set of boolean or floating point number or signed integer or strings

Default: { }

Example:

{
  listen-port = 60000;
  dht-listen-port = 60000;
  seed-ratio = 1.0;
  max-upload-limit = "50K";
  ftp-pasv = true;
}

Declared by:

Whether to enable Astroid.

Type: boolean

Default: false

Example: true

Declared by:

You can use %1, %2, and %3 to refer respectively to:

See https://github.com/astroidmail/astroid/wiki/Customizing-editor.

Type: null or string

Default: null

Example: "nvim-qt -- -c 'set ft=mail' '+set fileencoding=utf-8' '+set ff=unix' '+set enc=utf-8' '+set fo+=w' %1"

Declared by:

JSON config that will override the default Astroid configuration.

Type: JSON value

Default: { }

Example:

{
  poll.interval = 0;
}

Declared by:

Script to run to fetch/update mails.

Type: string

Default: ""

Example: "mbsync gmail"

Declared by:

Whether to enable autojump.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Bash integration.

Type: boolean

Default: true

Declared by:

Whether to enable Fish integration.

Type: boolean

Default: true

Declared by:

Whether to enable Zsh integration.

Type: boolean

Default: true

Declared by:

Whether to enable Autorandr.

Type: boolean

Default: false

Example: true

Declared by:

Global hook scripts

Type: submodule

Default: { }

Example:

{
  postswitch = {
    "notify-i3" = "${pkgs.i3}/bin/i3-msg restart";
    "change-background" = readFile ./change-background.sh;
    "change-dpi" = ''
      case "$AUTORANDR_CURRENT_PROFILE" in
        default)
          DPI=120
          ;;
        home)
          DPI=192
          ;;
        work)
          DPI=144
          ;;
        *)
          echo "Unknown profle: $AUTORANDR_CURRENT_PROFILE"
          exit 1
      esac

      echo "Xft.dpi: $DPI" | ${pkgs.xorg.xrdb}/bin/xrdb -merge
    ''
  };
}

Declared by:

Postswitch hook executed after mode switch.

Type: attribute set of strings concatenated with "\n"s

Default: { }

Declared by:

Predetect hook executed before autorandr attempts to run xrandr.

Type: attribute set of strings concatenated with "\n"s

Default: { }

Declared by:

Preswitch hook executed before mode switch.

Type: attribute set of strings concatenated with "\n"s

Default: { }

Declared by:

Autorandr profiles specification.

Type: attribute set of submodules

Default: { }

Example:

{
  "work" = {
    fingerprint = {
      eDP1 = "<EDID>";
      DP1 = "<EDID>";
    };
    config = {
      eDP1.enable = false;
      DP1 = {
        enable = true;
        crtc = 0;
        primary = true;
        position = "0x0";
        mode = "3840x2160";
        gamma = "1.0:0.909:0.833";
        rate = "60.00";
        rotate = "left";
      };
    };
    hooks.postswitch = readFile ./work-postswitch.sh;
  };
}

Declared by:

Per output profile configuration.

Type: attribute set of submodules

Default: { }

Declared by:

Whether to enable the output.

Type: boolean

Default: true

Declared by:

Output video display controller.

Type: null or unsigned integer, meaning >=0

Default: null

Example: 0

Declared by:

Output DPI configuration.

Type: null or positive integer, meaning >0

Default: null

Example: 96

Declared by:

Output gamma configuration.

Type: string

Default: ""

Example: "1.0:0.909:0.833"

Declared by:

Output resolution.

Type: string

Default: ""

Example: "3840x2160"

Declared by:

Output position

Type: string

Default: ""

Example: "5760x0"

Declared by:

Whether output should be marked as primary

Type: boolean

Default: false

Declared by:

Output framerate.

Type: string

Default: ""

Example: "60.00"

Declared by:

Output rotate configuration.

Type: null or one of "normal", "left", "right", "inverted"

Default: null

Example: "left"

Declared by:

Output scale configuration.

Either configure by pixels or a scaling factor. When using pixel method the xrandr(1) option --scale-from will be used; when using factor method the option --scale will be used.

This option is a shortcut version of the transform option and they are mutually exclusive.

Type: null or submodule

Default: null

Example:

{
  x = 1.25;
  y = 1.25;
}

Declared by:

Output scaling method.

Type: one of "factor", "pixel"

Default: "factor"

Example: "pixel"

Declared by:

Horizontal scaling factor/pixels.

Type: floating point number or positive integer, meaning >0

Declared by:

Vertical scaling factor/pixels.

Type: floating point number or positive integer, meaning >0

Declared by:

Refer to xrandr(1) for the documentation of the transform matrix.

Type: null or 3×3 matrix of floating point numbers

Default: null

Example:

[
  [ 0.6 0.0 0.0 ]
  [ 0.0 0.6 0.0 ]
  [ 0.0 0.0 1.0 ]
]

Declared by:

Output name to EDID mapping. Use autorandr --fingerprint to get current setup values.

Type: attribute set of strings

Default: { }

Declared by:

Profile hook scripts.

Type: submodule

Default: { }

Declared by:

Postswitch hook executed after mode switch.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Predetect hook executed before autorandr attempts to run xrandr.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Preswitch hook executed before mode switch.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Whether to enable GNU Bourne-Again SHell.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable integration with terminals using the VTE library. This will let the terminal track the current working directory.

Type: boolean

Default: false

Example: true

Declared by:

Extra commands that should be placed in ~/.bashrc. Note that these commands will be run even in non-interactive shells.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Controlling how commands are saved on the history list.

Type: list of one of "erasedups", "ignoredups", "ignorespace"s

Default: [ ]

Declared by:

Location of the bash history file.

Type: null or string

Default: null

Declared by:

Number of history lines to keep on file.

Type: signed integer

Default: 100000

Declared by:

List of commands that should not be saved to the history list.

Type: list of strings

Default: [ ]

Example: [ "ls" "cd" "exit" ]

Declared by:

Number of history lines to keep in memory.

Type: signed integer

Default: 10000

Declared by:

Extra commands that should be run when initializing an interactive shell.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Extra commands that should be run when logging out of an interactive shell.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Extra commands that should be run when initializing a login shell.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Environment variables that will be set for the Bash session.

Type: attribute set

Default: { }

Example: { MAILCHECK = 30; }

Declared by:

An attribute set that maps aliases (the top level attribute names in this option) to command strings or directly to build outputs.

Type: attribute set of strings

Default: { }

Example:

{
  ll = "ls -l";
  ".." = "cd ..";
}

Declared by:

Shell options to set.

Type: list of strings

Default: [ "histappend" "checkwinsize" "extglob" "globstar" "checkjobs" ]

Declared by:

Whether to enable bat, a cat clone with wings.

Type: boolean

Default: false

Example: true

Declared by:

Bat configuration.

Type: attribute set of strings

Default: { }

Example: { pager = "less -FR"; theme = "TwoDark"; }

Declared by:

Additional themes to provide.

Type: attribute set of strings concatenated with "\n"s

Default: { }

Example:

{
  dracula = builtins.readFile (pkgs.fetchFromGitHub {
    owner = "dracula";
    repo = "sublime"; # Bat uses sublime syntax for its themes
    rev = "26c57ec282abcaa76e57e055f38432bd827ac34e";
    sha256 = "019hfl4zbn4vm4154hh3bwk6hm7bdxbr1hdww83nabxwjn99ndhv";
  } + "/Dracula.tmTheme");
}

Declared by:

Whether to enable the beets music library manager. This defaults to false for state version ≥ 19.03. For earlier versions beets is enabled if programs.beets.settings is non-empty.

Type: boolean

Default: "false"

Declared by:

The beets package to use. Can be used to specify extensions.

Type: package

Default: pkgs.beets

Example:

(pkgs.beets.override { enableCheck = true; })

Declared by:

Configuration written to ~/.config/beets/config.yaml

Type: YAML value

Default: { }

Declared by:

Whether to enable Broot, a better way to navigate directories.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Bash integration.

Type: boolean

Default: true

Declared by:

Whether to enable Fish integration.

Type: boolean

Default: true

Declared by:

Whether to enable Zsh integration.

Type: boolean

Default: true

Declared by:

Package providing broot

Type: package

Default: pkgs.broot

Declared by:

Color configuration.

Complete list of keys (expected to change before the v1 of broot):

Add _fg for a foreground color and _bg for a background colors.

Type: attribute set of strings

Default: { }

Example:

{
  status_normal_fg = "grayscale(18)";
  status_normal_bg = "grayscale(3)";
  status_error_fg = "red";
  status_error_bg = "yellow";
  tree_fg = "red";
  selected_line_bg = "grayscale(7)";
  permissions_fg = "grayscale(12)";
  size_bar_full_bg = "red";
  size_bar_void_bg = "black";
  directory_fg = "lightyellow";
  input_fg = "cyan";
  flag_value_fg = "lightyellow";
  table_border_fg = "red";
  code_fg = "lightyellow";
}

Declared by:

Define new verbs. For more information, see https://dystroy.org/broot/documentation/configuration/#verb-definition-attributes.

The possible attributes are:

Type: list of attribute set of boolean or stringss

Default: [ { execution = ":parent"; invocation = "p"; } { execution = "\$EDITOR {file}"; invocation = "edit"; shortcut = "e"; } { execution = "\$EDITOR {directory}/{subpath}"; invocation = "create {subpath}"; } { execution = "less {file}"; invocation = "view"; } ]

Example:

[
  { invocation = "p"; execution = ":parent"; }
  { invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; }
  { invocation = "create {subpath}"; execution = "$EDITOR {directory}/{subpath}"; }
  { invocation = "view"; execution = "less {file}"; }
  {
    invocation = "blop {name}\\.{type}";
    execution = "/bin/mkdir {parent}/{type} && /usr/bin/nvim {parent}/{type}/{name}.{type}";
    from_shell = true;
  }
]

Declared by:

Whether to enable the browserpass extension host application.

Type: boolean

Default: false

Example: true

Declared by:

Which browsers to install browserpass for

Type: list of one of "chrome", "chromium", "firefox", "vivaldi"s

Default: [ "chrome" "chromium" "firefox" "vivaldi" ]

Example: [ "firefox" ]

Declared by:

Whether to enable Chromium.

Type: boolean

Default: false

Example: true

Declared by:

The Chromium package to use.

Type: package

Default: pkgs.chromium

Declared by:

List of Chromium extensions to install. To find the extension ID, check its URL on the Chrome Web Store.

To install extensions outside of the Chrome Web Store set updateUrl or crxPath and version as explained in the Chrome documentation.

Type: list of submodule or string convertible to its

Default: [ ]

Example:

[
  { id = "cjpalhdlnbpafiamejdnhcphjbkeiagm"; } # ublock origin
  {
    id = "dcpihecpambacapedldabdbpakmachpb";
    updateUrl = "https://raw.githubusercontent.com/iamadamdev/bypass-paywalls-chrome/master/updates.xml";
  }
  {
    id = "aaaaaaaaaabbbbbbbbbbcccccccccc";
    crxPath = "/home/share/extension.crx";
    version = "1.0";
  }
]

Declared by:

Path to the extension's crx file. Linux only.

Type: null or path

Default: null

Declared by:

The extension's ID from the Chome Web Store url or the unpacked crx.

Type: string matching the pattern [a-zA-Z]{32}

Default: ""

Declared by:

URL of the extension's update manifest XML file. Linux only.

Type: string

Default: "https://clients2.google.com/service/update2/crx"

Declared by:

The extension's version, required for local installation. Linux only.

Type: null or string

Default: null

Declared by:

Whether to enable command-not-found hook for interactive shell.

Type: boolean

Default: false

Example: true

Declared by:

Absolute path to programs.sqlite. By default this file will be provided by your channel (nixexprs.tar.xz).

Type: path

Default: "/nix/var/nix/profiles/per-user/root/channels/nixos/programs.sqlite"

Declared by:

Whether to manage .dir_colors and set LS_COLORS.

Type: boolean

Default: false

Declared by:

Whether to enable Bash integration.

Type: boolean

Default: true

Declared by:

Whether to enable Fish integration.

Type: boolean

Default: true

Declared by:

Whether to enable Zsh integration.

Type: boolean

Default: true

Declared by:

Extra lines added to .dir_colors file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Options to add to .dir_colors file. See dircolors --print-database for options.

Type: attribute set of strings

Default: { }

Example:

{
  OTHER_WRITABLE = "30;46";
  ".sh" = "01;32";
  ".csh" = "01;32";
}

Declared by:

Whether to enable direnv, the environment switcher.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Bash integration.

Type: boolean

Default: true

Declared by:

Whether to enable Fish integration.

Type: boolean

Default: true

Declared by:

Whether to enable nix-direnv, a fast, persistent use_nix implementation for direnv.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Zsh integration.

Type: boolean

Default: true

Declared by:

Configuration written to ~/.config/direnv/config.toml.

See direnv.toml(1). for the full list of options.

Type: TOML value

Default: { }

Declared by:

Custom stdlib written to ~/.config/direnv/direnvrc.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Whether to enable Eclipse.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable the Lombok Java Agent in Eclipse. This is necessary to use the Lombok class annotations.

Type: boolean

Default: false

Example: true

Declared by:

The Eclipse package to install.

Type: package

Default: pkgs.eclipses.eclipse-platform

Example:

pkgs.eclipses.eclipse-java

Declared by:

JVM arguments to use for the Eclipse process.

Type: list of strings

Default: [ ]

Declared by:

Plugins that should be added to Eclipse.

Type: list of packages

Default: [ ]

Declared by:

Whether to enable Emacs.

Type: boolean

Default: false

Example: true

Declared by:

The Emacs package to use.

Type: package

Default: pkgs.emacs

Example:

pkgs.emacs25-nox

Declared by:

Extra packages available to Emacs. To get a list of available packages run: nix-env -f '<nixpkgs>' -qaP -A emacsPackages.

Type: Function that takes an attribute set and returns a list containing a selection of the values of the input set

Default: "epkgs: []"

Example:

epkgs: [ epkgs.emms epkgs.magit ]

Declared by:

Allows overriding packages within the Emacs package set.

Type: An overlay function, takes self and super and returns an attribute set overriding the desired attributes.

Default: "self: super: {}"

Example:

self: super: rec {
  haskell-mode = self.melpaPackages.haskell-mode;
  # ...
};

Declared by:

Whether to enable exa, a modern replacement for ls.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable recommended exa aliases.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable feh - a fast and light image viewer.

Type: boolean

Default: false

Example: true

Declared by:

Override feh's default mouse button mapping. If you want to disable an action, set its value to null. If you want to bind multiple buttons to an action, set its value to a list. See https://man.finalrewind.org/1/feh/#x425554544f4e53 for default bindings and available commands.

Type: attribute set of null or string or signed integer or list of string or signed integerss

Default: { }

Example: { prev_img = [ 3 "C-3" ] ; zoom_in = 4; zoom_out = "C-4"; }

Declared by:

Override feh's default keybindings. If you want to disable a keybinding set its value to null. If you want to bind multiple keys to an action, set its value to a list. See https://man.finalrewind.org/1/feh/#x4b455953 for default bindings and available commands.

Type: attribute set of null or string or list of stringss

Default: { }

Example: { prev_img = [ "h" "Left" ] ; zoom_in = "plus"; zoom_out = "minus"; }

Declared by:

Whether to enable Firefox.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable the GNOME Shell native host connector. Note, you also need to set the NixOS option services.gnome3.chrome-gnome-shell.enable to true.

Type: boolean

Default: false

Declared by:

The Firefox package to use. If state version ≥ 19.09 then this should be a wrapped Firefox package. For earlier state versions it should be an unwrapped Firefox package.

Type: package

Default: pkgs.firefox

Declared by:

List of Firefox add-on packages to install. Some pre-packaged add-ons are accessible from NUR, https://github.com/nix-community/NUR. Once you have NUR installed run

  $ nix-env -f '<nixpkgs>' -qaP -A nur.repos.rycee.firefox-addons

to list the available Firefox add-ons.

Note that it is necessary to manually enable these extensions inside Firefox after the first installation.

Extensions listed here will only be available in Firefox profiles managed through the programs.firefox.profiles option. This is due to recent changes in the way Firefox handles extension side-loading.

Type: list of packages

Default: [ ]

Example:

with pkgs.nur.repos.rycee.firefox-addons; [
  https-everywhere
  privacy-badger
]

Declared by:

Attribute set of Firefox profiles.

Type: attribute set of submodules

Default: { }

Declared by:

Extra preferences to add to user.js.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Profile ID. This should be set to a unique number per profile.

Type: unsigned integer, meaning >=0

Default: 0

Declared by:

Whether this is a default profile.

Type: boolean

Default: "true if profile ID is 0"

Declared by:

Profile name.

Type: string

Default: "‹name›"

Declared by:

Profile path.

Type: string

Default: "‹name›"

Declared by:

Attribute set of Firefox preferences.

Type: attribute set of boolean or signed integer or strings

Default: { }

Example:

{
  "browser.startup.homepage" = "https://nixos.org";
  "browser.search.region" = "GB";
  "browser.search.isUS" = false;
  "distribution.searchplugins.defaultLocale" = "en-GB";
  "general.useragent.locale" = "en-GB";
  "browser.bookmarks.showMobileBookmarks" = true;
}

Declared by:

Custom Firefox user chrome CSS.

Type: strings concatenated with "\n"

Default: ""

Example:

''
/* Hide tab bar in FF Quantum */
@-moz-document url("chrome://browser/content/browser.xul") {
  #TabsToolbar {
    visibility: collapse !important;
    margin-bottom: 21px !important;
  }

  #sidebar-box[sidebarcommand="treestyletab_piro_sakura_ne_jp-sidebar-action"] #sidebar-header {
    visibility: collapse !important;
  }
}
''

Declared by:

Custom Firefox user content CSS.

Type: strings concatenated with "\n"

Default: ""

Example:

''
/* Hide scrollbar in FF Quantum */
*{scrollbar-width:none !important}
''

Declared by:

Whether to enable fish, the friendly interactive shell.

Type: boolean

Default: false

Example: true

Declared by:

The fish package to install. May be used to change the version.

Type: package

Default: pkgs.fish

Declared by:

Basic functions to add to fish. For more information see https://fishshell.com/docs/current/cmds/function.html.

Type: attribute set of strings concatenated with "\n" or submodules

Default: { }

Example:

{
  __fish_command_not_found_handler = {
    body = "__fish_default_command_not_found_handler $argv[1]";
    onEvent = "fish_command_not_found";
  };

  gitignore = "curl -sL https://www.gitignore.io/api/$argv";
}

Declared by:

Shell script code called during interactive fish shell initialisation.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Shell script code called during fish login shell initialisation.

Type: strings concatenated with "\n"

Default: ""

Declared by:

The plugins to source in conf.d/99plugins.fish.

Type: list of submodules

Default: [ ]

Example:

[
  {
    name = "z";
    src = pkgs.fetchFromGitHub {
      owner = "jethrokuan";
      repo = "z";
      rev = "ddeb28a7b6a1f0ec6dae40c636e5ca4908ad160a";
      sha256 = "0c5i7sdrsp0q3vbziqzdyqn4fmp235ax4mn4zslrswvn8g3fvdyh";
    };
  }

  # oh-my-fish plugins are stored in their own repositories, which
  # makes them simple to import into home-manager.
  {
    name = "fasd";
    src = pkgs.fetchFromGitHub {
      owner = "oh-my-fish";
      repo = "plugin-fasd";
      rev = "38a5b6b6011106092009549e52249c6d6f501fba";
      sha256 = "06v37hqy5yrv5a6ssd1p3cjd9y3hnp19d3ab7dag56fs1qmgyhbs";
    };
  }
]

Declared by:

The name of the plugin.

Type: string

Declared by:

Path to the plugin folder.

Relevant pieces will be added to the fish function path and the completion path. The init.fish and key_binding.fish files are sourced if they exist.

Type: path

Declared by:

Shell script code used to initialise fish prompt.

Type: strings concatenated with "\n"

Default: ""

Declared by:

An attribute set that maps aliases (the top level attribute names in this option) to abbreviations. Abbreviations are expanded with the longer phrase after they are entered.

Type: attribute set of strings

Default: { }

Example: { gco = "git checkout"; l = "less"; }

Declared by:

An attribute set that maps aliases (the top level attribute names in this option) to command strings or directly to build outputs.

Type: attribute set of strings

Default: { }

Example:

{
  ll = "ls -l";
  ".." = "cd ..";
}

Declared by:

Shell script code called during fish shell initialisation.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Whether to enable fzf - a command-line fuzzy finder.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Bash integration.

Type: boolean

Default: true

Declared by: