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

CLI reference

lictor -h prints a compact summary; lictor --help adds details, selectors, more examples and exit codes. No arguments opens the TUI; with arguments Lictor runs directly, unless --tui is given to review them in the controller first.

lictor -W -A -s 5               # focus each workspace, then each agent, every 5 seconds
lictor -W -A -s 5 -S w,a        # new tab: workspaces mirrored left, agents right
lictor --tui -W -A -s 5 -S w,a  # same, reviewed in the controller first
lictor -A --status blocked,done # visit only agents waiting for you
lictor --jobs                   # running jobs and retained mirror tabs
lictor --stop                   # stop running rotations

Targets

OptionMeaning
-W, --workspacesRotate workspaces.
-A, --agentsRotate recognized agents.
-T, --tabsRotate tabs of the current workspace. -w/--windows remain as hidden legacy aliases.
-p, --targets LISTOnly these targets, in this order; repeat one for extra dwell. --panes is an alias.
--status STATESOnly visit agents in these states (idle, working, blocked, done, unknown), checked live. Implies -A.
-c, --active-tabWith -W -A, show each workspace’s active tab instead of its first.
-t, --target IDResolve relative selectors from this workspace, tab or pane.

See selectors and agent status. Group flags may be combined; their order on the command line is the rotation order. When -T is mixed with -W or -A, prefix -p entries with their kind (tab=, workspace=, agent=, pane=).

Timing

OptionMeaning
-s, --seconds SECONDSSeconds on each target; default 3; dot or comma decimals. --interval is an alias.
-n, --iterations NStop after N successful moves; 0 (default) runs until stopped. In split mode every lane advance counts.
-r, --randomShuffle the order after every lap, keeping repeated entries.

Split view

OptionMeaning
-S, --split LEFT,RIGHTNew tab with two live mirrors; one kind per lane: w, t, a or p (e.g. w,a).
--left-targets LISTTargets for the left lane; default all of its kind.
--right-targets LISTTargets for the right lane; default all of its kind.
--close-on-exitClose the mirror tab when the rotation stops instead of leaving it live on the last targets.

Split lane kinds imply their target groups; extra group flags must match a lane. -p does not select split lanes. See split observation.

Preview

OptionMeaning
--tuiOpen the keyboard controller with these settings.
-l, --listList matching targets and exit.
-a, --allWith --list, include the whole session.
-d, --dry-runShow the targets and first steps (5, or -n) without changing Herdr.

Listing and dry-run never focus targets or create tabs. Dry-run uses current agent states and cannot predict later changes.

Jobs

OptionMeaning
--jobsList running jobs and retained mirror tabs.
-k, --stopStop running rotations.
--pause, --resumePause or resume rotations.
--close-viewClose retained mirror tabs.
--job IDAct on one job with the options above; alone, print its state; with --tui, open the controller on it.

Without --job, the actions apply to all of the current user’s jobs. Use only one action at a time. See jobs.

Herdr

OptionMeaning
-L, --session NAMEUse a named Herdr session.
--socket-path PATHUse this Herdr API socket; exclusive with --session.
-b, --sidebar ACTIONshow, hide or toggle the sidebar while rotating; restored on stop.
--sidebar-keepKeep the sidebar as set after stopping.
--no-notifyNo desktop notification when the rotation stops.

See sidebar controls for platform support.

Output and general

OptionMeaning
-v, --verbosePrint every move with a timestamp.
-q, --quietPrint less.
-h, --helpCompact help; --help for details.
-V, --versionShow the version.

Invalid combinations are rejected before anything changes, with a hint on how to fix them.

Packaging

lictor --generate FORMAT prints the man page or a shell completion script to standard output. FORMAT is one of man, bash, zsh or fish:

lictor --generate man | gzip -9n > lictor.1.gz
lictor --generate zsh > _lictor

It is hidden from --help because the release packages already install these files; use it when packaging Lictor yourself. It cannot be combined with other options.

Exit codes

CodeMeaning
0Success or clean stop.
1General runtime failure.
2Invalid arguments.
3Missing targets, every target disappeared, or no job to control.
4Herdr/server/socket unavailable.