Files

m3tm3re 44485c4c72 docs: update zellij-ps to reflect project switcher functionality

- Update package description and fix mainProgram typo
- Rewrite documentation to describe project switching, not process viewing
- Add PROJECT_FOLDERS configuration and usage examples
- Update all references across docs (README, guides, module overviews)

2025-12-30 15:42:52 +01:00

1.6 KiB

Raw Blame History

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];

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

Module Options

`m3ta.cli.zellij-ps.enable`

Enable zellij-ps module.

Type: boolean
Default: false

`m3ta.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

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

Configuration

Custom Package

Use a custom or modified package:

m3ta.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

zellij-ps Package - Package documentation
Using Modules Guide - Module usage patterns

1.6 KiB Raw Blame History