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.flashspace.enable

Whether to enable FlashSpace workspace manager for macOS.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.flashspace.package

The flashspace package to use.

Type: null or package

Default:

pkgs.flashspace

Declared by:

programs.flashspace.profiles

Profiles, workspaces, and app assignments written to $XDG_CONFIG_HOME/flashspace/profiles.json.

The root attribute must be profiles, containing a list of profile objects. Each profile holds a list of workspaces, and each workspace holds a list of apps identified by their bundleIdentifier.

See https://github.com/wojciech-zurek/FlashSpace for the full schema.

Type: JSON value

Default:

{ }

Example:

{
  profiles = [
    {
      id = "550e8400-e29b-41d4-a716-446655440000";
      name = "Work";
      shortcut = "control+option+1";
      workspaces = [
        {
          apps = [
            {
              autoOpen = true;
              bundleIdentifier = "com.apple.dt.Xcode";
              name = "Xcode";
            }
            {
              autoOpen = true;
              bundleIdentifier = "com.googlecode.iterm2";
              name = "iTerm2";
            }
          ];
          display = "Built-in Retina Display";
          id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";
          name = "Coding";
          openAppsOnActivation = true;
          shortcut = "cmd+1";
          symbolIconName = "terminal.fill";
        }
        {
          apps = [
            {
              autoOpen = false;
              bundleIdentifier = "com.tinyspeck.slackmacgap";
              name = "Slack";
            }
          ];
          display = "Built-in Retina Display";
          id = "b2c3d4e5-f6a7-8901-bcde-f12345678901";
          name = "Communication";
          openAppsOnActivation = false;
          shortcut = "cmd+2";
          symbolIconName = "message.fill";
        }
      ];
    }
  ];
}

Declared by:

programs.flashspace.settings

General app settings written to $XDG_CONFIG_HOME/flashspace/settings.toml.

Covers hotkeys, display mode, transition effects, focus navigation, gestures, integrations, and advanced options.

See https://github.com/wojciech-zurek/FlashSpace for available keys.

Type: TOML value

Default:

{ }

Example:

{
  centerCursorOnWorkspaceChange = true;
  displayMode = "static";
  enableWorkspaceTransitions = true;
  integrations = {
    enableIntegrations = true;
    runScriptOnWorkspaceChange = "~/.config/flashspace/scripts/notify.sh";
  };
  showFlashSpace = "cmd+shift+space";
  showFloatingNotifications = true;
  toggleFlashSpace = "control+option+command+t";
  workspaceTransitionDuration = 0.25;
}

Declared by: