LibTmuxWorkspace API reference
LibTmuxWorkspace 0.1.0-alpha.1 · Source
Use LibTmuxWorkspace to read, validate, plan and load workspace files.
Validation and planning do not contact tmux. Applying a plan can create
resources and execute shell input.
Read the package guide for installation and complete examples.
API declarations
Follow a declaration for its signature, members, documentation, and source.
Exports
LibTmuxWorkspace.applyBase.closeBase.showerrorLibTmuxWorkspace.BeforeScriptErrorLibTmuxWorkspace.CommandConfig- Inert pane text. enter=nothing inherits the pane's submission policy.
LibTmuxWorkspace.ConfigLimits- Bound document bytes, nesting and total values before schema normalization.
LibTmuxWorkspace.expandLibTmuxWorkspace.ExpandedPaneLibTmuxWorkspace.ExpandedWindowLibTmuxWorkspace.ExpandedWorkspace- A workspace with explicit directories, environment values and ordered commands.
LibTmuxWorkspace.freezeLibTmuxWorkspace.install_cliLibTmuxWorkspaceLibTmuxWorkspace.mainLibTmuxWorkspace.PaneConfigLibTmuxWorkspace.parse_configLibTmuxWorkspace.planLibTmuxWorkspace.PlanStep- An inert effect with 1-based config window/pane positions, not tmux indices. nothing denotes session/global scope. arguments contains owned values.
LibTmuxWorkspace.read_configLibTmuxWorkspace.run_before_scriptLibTmuxWorkspace.ScriptResult- Bounded script output and direct-child exit evidence; the child has been reaped.
LibTmuxWorkspace.validateLibTmuxWorkspace.WindowConfigLibTmuxWorkspace.WorkspaceApplyErrorLibTmuxWorkspace.WorkspaceApplyResult- Known creations, completed plan steps and effects requiring caller inspection.
LibTmuxWorkspace.WorkspaceConfig- Validated, owned values. Version 1 also accepts unversioned tmuxp documents.
LibTmuxWorkspace.WorkspaceConfigError- A stable diagnostic code and document path, without interpolated config values.
LibTmuxWorkspace.WorkspaceDocument- Parsed data plus its optional absolute source path. Call validate before use.
LibTmuxWorkspace.WorkspacePlan