Workspace ManagerCLI Manual

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Edit this page on GitHub

tmux-workspace CLI manual

LibTmux.Workspace 0.0.0-alpha.20 · Source

Use tmux-workspace to load, inspect and save workspace files. Complete installation and put the executable on PATH before using these commands.

Sessions

load
Create a session from a workspace file.
freeze
Capture a running session into a workspace document.

Workspace files

ls
List saved configurations.
search
Find saved configurations.
edit
Open a configuration in your editor.
convert
Change a document between YAML and JSON.
import
Translate Teamocil or tmuxinator configuration.

Diagnostics and completion

debug-info
Report runtime and tmux information.
completion
Generate completion for your shell.

Command options

Show the options accepted by the installed command:

Terminal window
$ tmux-workspace load --help

Machine output

--json requests one JSON result. --ndjson requests a stream of records and takes precedence when both are present. Select detached loading with -d when automating session creation. Check the exit status as well as the result; a failed load can leave completed tmux operations in place.

The output reference describes the result records, and automation covers scripts.

CLI source.

Esc

Type to search.