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

Exit codes and errors

LibTmux.Workspace 0.0.0-alpha.20 · Source

Check the process status before treating a result as complete. A failed load can report retained effects; a later failure does not undo an earlier input.

Exit statusMeaning
0Command completed; an explicitly declined prompt can also finish without changes
1Workspace validation or operation failure
2Invalid arguments or execution context
130Interrupted operation

Child commands such as edit can propagate another nonzero child status. Status 70 reports an internal error.

Machine errors

With --json or --ndjson, diagnostics identify a code and readable message. Use the code for program decisions and keep the message for users.

CodeCondition
workspace_not_foundRequested workspace was not found
invalid_workspaceDocument shape or value is invalid
unsupported_keyAn execution field is unsupported
session_not_foundThe selected session does not exist
session_mismatchExisting session does not match the requested document
tmux_unavailabletmux cannot be found or used
tmux_failedA tmux operation failed
script_failedA bootstrap process failed
destination_existsA file would be replaced without authorization
usageArguments or execution context are invalid
interruptedA signal stopped the operation

Additional codes describe implementation failures such as a closed output stream, unavailable runtime or log-file failure. Keep unknown codes visible instead of assuming they mean success. See troubleshooting for collecting a useful report.

CLI source.

Esc

Type to search.