tmuxp shell

Edit this page on GitHub

workspace consumer 0.1.0-alpha.10 · Source

tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.

Open a Python shell with tmux objects available, or evaluate Python using -c. This command remains Python-specific even when reached through a native command.

Native executionLink to section

The development C++ CLI invokes an installed tmuxp 1.74.0 console executable. Put it on PATH, or set TMUX_WORKSPACE_TMUXP to its executable path. That value accepts a single path, including spaces, without interpreter arguments. Optional backends belong in the selected executable’s Python environment.

Continue the installation walkthrough through its detached load, leaving workspace-guide running in the same shell:

$ build/cxx-dev/apps/workspace/tmux-workspace shell \
    -S "$WORKSPACE_TMP/tmux.sock" \
    -c 'print(pane.pane_id)' \
    --json \
    workspace-guide editor

JSON captures runtime stdout, stderr and status under "script_output". NDJSON emits flushed script-output records with "stream" and "text", then a completed or failed result. Capture is limited to 1 MiB per stream; overflow stops the child group and reports OUTPUT_LIMIT with bounded output. Human output streams to its original destinations. The runtime’s own messages remain part of its output.

Machine calls require -c, including an empty code string. Interactive human calls require a foreground controlling terminal; exit restores its settings and foreground group. SIGINT and SIGTERM sent to the workspace process cancel its owned child group. -S takes precedence over -L, and opposing startup flags keep their original order. See the native shell contract.

Evaluate with a selected serverLink to section

After the installation walkthrough starts its dedicated server:

$ tmuxp shell \
    -S "$WORKSPACE_TMP/tmux.sock" \
    -c 'print(server.sessions)' \
    workspace-guide editor

Use -c; the reference does not define --command. Optional session and window arguments select context. --best chooses the best available shell backend; the explicit selectors require their corresponding Python packages. The --pdb path uses a debugger rather than a normal REPL.

The paired --use-pythonrc / --no-startup and --use-vi-mode / --no-vi-mode options share destinations. The last occurrence wins. The negative options disable the corresponding setting. See environment for startup and backend settings.

A native REPL is not an equivalent implementation of Python -c, IPython, or PTPython. Native ports that support this command use an optional version-checked Python bridge and report an unsupported-runtime error if it is absent. Check port coverage before relying on that bridge. The C++ command requires -c for machine output.

Backend selectors are mutually exclusive.

Arguments and flagsLink to section

All commands accept -h / --help. Root options precede the command; see the CLI overview. The output reference distinguishes current Python flags from native all-command JSON and NDJSON.

Parser and implementation source.

tmuxp reference source.