Files
nixpkgs/docs/modules/home-manager/cli/zellij-ps.md
m3tm3re 00b858fbbe docs: update documentation for latest changes
- Add stt-ptt language support documentation
- Add rofi-project-opener module documentation
- Add rofi-project-opener package documentation
- Update zellij-ps documentation
- Update guides and reference patterns
- Update AGENTS.md with latest commands
2026-01-10 19:12:45 +01:00

1.6 KiB

zellij-ps Home Manager Module

Zellij project switcher for Home Manager.

Overview

This module configures the zellij-ps tool, a Fish script that provides a fast, interactive way to switch between project folders in Zellij terminal multiplexer sessions.

Quick Start

{config, ...}: {
  imports = [m3ta-nixpkgs.homeManagerModules.default];

  cli.zellij-ps = {
    enable = true;
  };
}

Module Options

cli.zellij-ps.enable

Enable zellij-ps module.

  • Type: boolean
  • Default: false

cli.zellij-ps.package

Custom package to use.

  • Type: package
  • Default: pkgs.zellij-ps

Usage

After enabling, zellij-ps will be available in your path:

# Run from outside Zellij to start a project session
zellij-ps

# Or pass a project path directly
zellij-ps ~/projects/my-project

Basic Usage

  1. Set $PROJECT_FOLDERS in your shell config (e.g., ~/projects:~/code)
  2. Run zellij-ps from outside a Zellij session
  3. Use fzf to select a project from your configured folders
  4. Zellij will create or attach to a session for that project

Configuration

Custom Package

Use a custom or modified package:

cli.zellij-ps = {
  enable = true;
  package = pkgs.callPackage ./my-zellij-ps {};
};

Dependencies

The module ensures these are installed:

  • fish - Shell for script execution
  • fd - Fast file search
  • fzf - Fuzzy finder
  • zellij - Terminal multiplexer