tmux-workspace 0.1.0-alpha.12 · Source
These pages document the in-development workspace builder for contributors and applications that call its APIs. For workspace loading from a terminal, see tmuxp.
Builder pipelineLink to section
Workspace::from_yaml parses the description. WorkspaceBuilder turns it
into a command plan or builds a new session through a borrowed Server.
freeze reads a session back into workspace data. The caller supplies file
reading, the async runtime, command-line handling, and attachment.
Read the implementationLink to section
- Guides show builder setup and application code.
- Topics explain configuration, behavior, and failures.
- Examples exercise the builder through the language API.
- API links the configuration and construction interfaces.
Implementation scopeLink to section
tmux-workspace creates a tmux session from a
tmuxp-style YAML description.
The crate uses the public libtmux API and returns a typed session handle. A
separate freeze operation records an existing session as workspace data.
Building creates a new session. It refuses an already existing session with the requested name, so repeated builds require a new name or explicit cleanup.
Package and runtimeLink to section
Add tmux-workspace separately from the core crate. Workspace creation and
freezing are asynchronous and require a running Tokio runtime and tmux on the
host. Pin a prerelease explicitly; a stable-only Cargo requirement does not
select an alpha release.
The format covers a subset of tmuxp. Unknown keys are recorded in
unsupported_keys by
the parser. Review those lists before assuming a Python workspace’s setup
hooks or configuration have taken effect.