Compatibility
- Final python 3.7 and 3.8 release
Bug fixes and security updates will go to
[`v1.10.x`](https://github.com/tmux-python/tmuxp/tree/v1.10.x)
What's new
- 747: Skip execution via `enter: false`
See {ref}`enter`.
:::{note}
_Experimental setting_: behavior and api is subject to change until stable.
:::
yaml
session_name: Should not execute
windows:
- panes:
- shell_command:
- echo "this sends"
- cmd: echo "___$((1 + 3))___"
enter: false
pane-wide skip
- shell_command:
- echo "___$((1 + 3))___"
enter: false
- 750: Pause execution via `sleep_before: [int]` and `sleep_after: [int]`
See {ref}`sleep`.
:::{note}
_Experimental setting_: behavior and api is subject to change until stable.
:::
yaml
session_name: Pause / skip command execution (command-level)
windows:
- panes:
- shell_command:
Executes immediately
- echo "___$((11 + 1))___"
Delays before sending 2 seconds
- cmd: echo "___$((1 + 3))___"
sleep_before: 2
Executes immediately
- cmd: echo "___$((1 + 3))___"
Pauses 2 seconds after
- cmd: echo "Stuff rendering here!"
sleep_after: 2
Executes after earlier commands (after 2 sec)
- cmd: echo "2 seconds later"
- 701: `tmuxp freeze` now accepts `--quiet` and `--yes` along with the
`--config-format` and filename (`--save-to`). This means you can do it all in
one command:
`tmuxp freeze -yqo .tmuxp.yaml`
Or bind it to `.tmux.conf` itself: `bind -T root C-s run-shell "tmuxp freeze -yqo .tmuxp.yaml"`
Credit: [davidatbu](https://github.com/davidatbu)
- 672: Panes now accept `shell` for their initial command.
Equivalent to `tmux split-windows`'s `[shell-command]`
yaml
session_name: Pane shell example
windows:
- window_name: first
window_shell: /usr/bin/python2
layout: even-vertical
suppress_history: false
options:
remain-on-exit: true
panes:
- shell: /usr/bin/python3
shell_command:
- print('This is python 3')
- shell: /usr/bin/vim -u none
shell_command:
- iAll panes have the `remain-on-exit` setting on.
- When you exit out of the shell or application, the panes will remain.
- Use tmux command `:kill-pane` to remove the pane.
- Use tmux command `:respawn-pane` to restart the shell in the pane.
- Use <Escape> and then `:q!` to get out of this vim window. :-)
- shell_command:
- print('Hello World 2')
- shell: /usr/bin/top
Credit: jerri
Improvements
- Improve `tmuxp freeze` UX flow, credit joseph-flinn (657, in re: 627)
- `tmuxp freeze` will now detect the attached session if no session name
is specified. Credit: will-ockmore. (660)
Bugs
- Fix loading of `.yml` files with `tmuxp convert`, thank you kalixi! (725)
Internal API
- 752: Command structure (internal API)
To pave the way for per-command options such as `enter: false` (53), commands are now a different format:
Before, [`str`](str):
python
"echo hello"
After, {py:class}`dict`:
python
{
"cmd": "echo hello"
}
This is purely internal. Normal usage should be the same since the
configuration emits the equivalent result.
- 752: Configuration parsing refactorings
Development
- Run through black + isort with string normalization (738). This way we can
use black without any configuration. (One-time, big diff)
- Run codebase through pyupgrade (745)
- Add `codeql-analysis.yml` to try it out
Documentation
- Move to `furo` sphinx theme
- Reorganize documentation into sections
- Added examples for `enter: false` and `sleep: [second]`