Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.vicinae.enable

Whether to enable vicinae launcher daemon.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.vicinae.enableFirefoxIntegration

Whether to install the messaging host so that the firefox extension https://addons.mozilla.org/en-US/firefox/addon/vicinae/ works.

Type: unspecified value

Default:

true

Declared by:

programs.vicinae.package

The vicinae package to use.

Type: null or package

Default:

pkgs.vicinae

Declared by:

programs.vicinae.extensions

List of Vicinae extensions to install.

You can use the config.lib.vicinae.mkExtension and config.lib.vicinae.mkRayCastExtension functions to create them, like:

 [
  (config.lib.vicinae.mkExtension {
    name = "test-extension";
    npmDepsHash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
    src =
      pkgs.fetchFromGitHub {
        owner = "schromp";
        repo = "vicinae-extensions";
        rev = "f8be5c89393a336f773d679d22faf82d59631991";
        sha256 = "sha256-zk7WIJ19ITzRFnqGSMtX35SgPGq0Z+M+f7hJRbyQugw=";
      }
      + "/test-extension";
  })
  (config.lib.vicinae.mkRayCastExtension {
    name = "gif-search";
    sha256 = "sha256-G7il8T1L+P/2mXWJsb68n4BCbVKcrrtK8GnBNxzt73Q=";
    rev = "4d417c2dfd86a5b2bea202d4a7b48d8eb3dbaeb1";
    npmDepsHash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
  })
  (config.lib.vicinae.mkRayCastExtension {
    name = "my-local-raycast-extension";
    src = ./extensions/my-local-raycast-extension;
  })
 ],

Set npmDepsHash when src is produced by a fetcher such as pkgs.fetchFromGitHub or pkgs.fetchgit; otherwise dependency import reads package-lock.json from the fetched source during evaluation.

Type: list of package

Default:

[ ]

Declared by:

programs.vicinae.settings

Settings written as JSON to ~/.config/vicinae/settings.json. See vicinae config default.

Type: JSON value

Default:

{ }

Example:

{
  favicon_service = "twenty";
  font = {
    normal = {
      size = 10;
    };
  };
  pop_to_root_on_close = false;
  search_files_in_root = false;
  theme = {
    dark = {
      name = "vicinae-dark";
    };
    light = {
      name = "vicinae-light";
    };
  };
}

Declared by:

programs.vicinae.systemd.enable

Whether to enable vicinae systemd integration.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.vicinae.systemd.autoStart

If the vicinae daemon should be started automatically

Type: boolean

Default:

true

Declared by:

programs.vicinae.systemd.target

The systemd target that will automatically start the vicinae service.

Type: string

Default:

"graphical-session.target"

Example:

"sway-session.target"

Declared by:

programs.vicinae.themes

Theme settings to add to the themes folder in ~/.config/vicinae/themes. See https://docs.vicinae.com/theming/getting-started for supported values.

The attribute name of the theme will be the name of theme file, e.g. base16-default-dark will be base16-default-dark.toml (or .json if vicinae version is < 0.15.0).

Type: TOML value

Default:

{ }

Example:

# vicinae >= 0.15.0
{
  catppuccin-mocha = {
    meta = {
      version = 1;
      name = "Catppuccin Mocha";
      description = "Cozy feeling with color-rich accents";
      variant = "dark";
      icon = "icons/catppuccin-mocha.png";
      inherits = "vicinae-dark";
    };

    colors = {
      core = {
        background = "#1E1E2E";
        foreground = "#CDD6F4";
        secondary_background = "#181825";
        border = "#313244";
        accent = "#89B4FA";
      };
      accents = {
        blue = "#89B4FA";
        green = "#A6E3A1";
        magenta = "#F5C2E7";
        orange = "#FAB387";
        purple = "#CBA6F7";
        red = "#F38BA8";
        yellow = "#F9E2AF";
        cyan = "#94E2D5";
      };
    };
  };
}

Declared by:

programs.vicinae.useLayerShell

Whether vicinae should use the layer shell. If you are using version 0.17 or newer, you should use {option}.programs.vicinae.settings.launcher_window.layer_shell.enabled = false instead.

Type: boolean

Default:

true

Declared by: