tmuxp.cli.load.command_load

API reference · Markdown

tmuxp.cli.load.command_load ( args : CLILoadNamespace , parser : argparse.ArgumentParser | None = None ) → None

function [source] ¶

function [source] ¶

tmuxp.cli.load.command_load

Load a tmux workspace from each WORKSPACE_FILE.

WORKSPACE_FILE is a specifier for a workspace file.

If WORKSPACE_FILE is a path to a directory, tmuxp will search it for ".tmuxp.{yaml,yml,json}".

If WORKSPACE_FILE is has no directory component and only a filename, e.g. "myworkspace.yaml", tmuxp will search the users's workspace directory for that file.

If WORKSPACE_FILE has no directory component, and only a name with no extension, e.g. "myworkspace", tmuxp will search the users's workspace directory for any file with the extension ".yaml", ".yml", or ".json" that matches that name.

If multiple workspace files that match a given WORKSPACE_FILE are found, tmuxp will warn and pick the first one found.

If multiple WORKSPACE_FILEs are provided, workspaces will be created for all of them. The last one provided will be attached. The others will be created in detached mode.