CLI Reference

GMUX Grove tmux management tool

A CLI tool for managing tmux sessions and configurations in the Grove ecosystem.

USAGE gmux [command]

COMMANDS completion Generate the autocompletion script for the specified shell history View and switch to recently accessed project sessions key Manage tmux session key bindings km Alias for ‘key manage’ - Interactively manage tmux session key mappings launch Launch a new tmux session with optional panes list List tmux sessions from configuration (alias for ‘key list’) record-session Record the current tmux session to access history session Manage tmux sessions sessionize Quickly create or switch to tmux sessions from project directories start Start a pre-configured tmux session status Show git status for configured sessions version Print the version information for this binary wait Wait for a tmux session to close windows Interactively manage windows in the current tmux session

Flags: —config-dir, -h/—help, -v/—version

Use “gmux [command] —help” for more information.

GMUX HISTORY View and switch to recently accessed project sessions

Shows an interactive TUI listing recently accessed project sessions, sorted from most to least recent.

USAGE gmux history [flags] gmux history [command]

COMMANDS last Switch to the most recently accessed project session

Flags: -h/—help

Use “gmux history [command] —help” for more information.

GMUX HISTORY LAST Switch to the most recently accessed project session

Switches to the most recently used project session without showing the interactive UI.

USAGE gmux history last [flags]

FLAGS -h, —help help for last

GMUX KEY Manage tmux session key bindings

Commands for managing tmux session key bindings including updating keys and editing session details.

USAGE gmux key [command]

COMMANDS add Add a new session from available projects in search paths edit Edit the details of a tmux session (path, repository, description) list List all configured session keys manage Interactively manage tmux session key mappings unmap Unmap a session from its key binding update Update the key binding for a tmux session

Flags: -h/—help

Use “gmux key [command] —help” for more information.

GMUX KEY ADD Add a new session from available projects in search paths

Discover projects from configured search paths and quickly map them to available keys.

USAGE gmux key add [flags]

FLAGS -h, —help help for add

GMUX KEY EDIT Edit the details of a tmux session (path, repository, description)

Edit the path, repository name, and description for an existing tmux session. If no key is provided, shows all sessions for selection.

USAGE gmux key edit [key] [flags]

FLAGS -h, —help help for edit

GMUX KEY LIST List all configured session keys

USAGE gmux key list [flags]

FLAGS -h, —help help for list —style Output style: table or compact (default: table)

GMUX KEY MANAGE Interactively manage tmux session key mappings

Open an interactive table to map/unmap sessions to keys. Use arrow keys to navigate, ‘e’ to map CWD to an empty key, and space to unmap. Changes are auto-saved on exit.

USAGE gmux key manage [flags]

FLAGS -h, —help help for manage

GMUX KEY UNMAP Unmap a session from its key binding

Remove the mapping for a specific key, making it available for future use.

USAGE gmux key unmap [key] [flags]

FLAGS -h, —help help for unmap

GMUX KEY UPDATE Update the key binding for a tmux session

Update the key binding for an existing tmux session. If no key is provided, shows all sessions for selection.

USAGE gmux key update [current-key] [flags]

FLAGS -h, —help help for update

GMUX KM Alias for 'key manage' - Interactively manage tmux session key mappings

USAGE gmux km [flags]

FLAGS -h, —help help for km

GMUX LAUNCH Launch a new tmux session with optional panes

Launch a new tmux session with support for multiple panes.

USAGE gmux launch <session-name> [flags]

FLAGS -h, —help help for launch —pane Add a pane with command (can be used multiple times). Format: ‘command[@workdir]’ —window-name Name for the initial window —working-dir Working directory for the session

EXAMPLES # Simple session gmux launch dev-session

# Session with window name and working directory gmux launch dev-session —window-name coding —working-dir /path/to/project

# Session with multiple panes gmux launch dev-session —pane “vim main.go” —pane “go test -v” —pane “htop”

# Complex panes with working directories (format: command[@workdir]) gmux launch dev-session —pane “npm run dev@/app/frontend” —pane “go run .@/app/backend”

GMUX LIST List tmux sessions from configuration (alias for 'key list')

USAGE gmux list [flags]

FLAGS -h, —help help for list —style Output style: table or compact (default: table)

GMUX SESSION Manage tmux sessions

Commands for managing tmux sessions including checking existence, killing sessions, and capturing pane content.

USAGE gmux session [command]

COMMANDS capture Capture content from a tmux pane exists Check if a tmux session exists kill Kill a tmux session

Flags: -h/—help

Use “gmux session [command] —help” for more information.

GMUX SESSION CAPTURE Capture content from a tmux pane

Capture content from a tmux pane. Target can be session-name, session-name:window.pane, etc.

USAGE gmux session capture <target> [flags]

FLAGS -h, —help help for capture

GMUX SESSION EXISTS Check if a tmux session exists

USAGE gmux session exists <session-name> [flags]

FLAGS -h, —help help for exists

GMUX SESSION KILL Kill a tmux session

USAGE gmux session kill <session-name> [flags]

FLAGS -h, —help help for kill

GMUX SESSIONIZE Quickly create or switch to tmux sessions from project directories

Discover projects from configured search paths and quickly create or switch to tmux sessions. Shows Claude session status indicators when grove-hooks is installed.

USAGE gmux sessionize [flags] gmux sessionize [command]

COMMANDS add [DEPRECATED] Add an explicit project to sessionizer remove [DEPRECATED] Remove an explicit project from sessionizer

Flags: -h/—help

Use “gmux sessionize [command] —help” for more information.

GMUX SESSIONIZE ADD [DEPRECATED] Add an explicit project to sessionizer

This command is deprecated. Project discovery is now managed via the global grove.yml ‘groves’ configuration.

USAGE gmux sessionize add [path] [flags]

FLAGS -h, —help help for add

GMUX SESSIONIZE REMOVE [DEPRECATED] Remove an explicit project from sessionizer

This command is deprecated. Project discovery is now managed via the global grove.yml ‘groves’ configuration.

USAGE gmux sessionize remove [path] [flags]

FLAGS -h, —help help for remove

GMUX START Start a pre-configured tmux session

Start a tmux session using configuration from tmux-sessions.yaml.

The session will be created with the name ‘grove-<key>’ and will automatically change to the configured directory for that session.

USAGE gmux start <key> [flags]

FLAGS -h, —help help for start

GMUX STATUS Show git status for configured sessions

USAGE gmux status [flags]

FLAGS -h, —help help for status

GMUX VERSION Print the version information for this binary

USAGE gmux version [flags]

FLAGS -h, —help help for version —json Output version information in JSON format

GMUX WAIT Wait for a tmux session to close

Block until the specified tmux session closes. Useful for scripting and automation.

The command will poll at regular intervals to check if the session still exists. When the session closes, the command exits with status 0. If the timeout is reached or an error occurs, it exits with non-zero status.

USAGE gmux wait <session-name> [flags]

FLAGS -h, —help help for wait —poll-interval How often to check if session exists (default: 1s) —timeout Maximum time to wait (0 = no timeout) (default: 0s)

GMUX WINDOWS Interactively manage windows in the current tmux session

Launches a TUI to list, filter, and manage windows in the current tmux session.

USAGE gmux windows [flags]

FLAGS -h, —help help for windows