Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bartste/tmux-key2pane
Send commands to any tmux pane.
https://github.com/bartste/tmux-key2pane
bash command-line command-line-tool fish linux neovim python3 tmux vim zsh
Last synced: 26 days ago
JSON representation
Send commands to any tmux pane.
- Host: GitHub
- URL: https://github.com/bartste/tmux-key2pane
- Owner: BartSte
- License: mit
- Created: 2024-04-03T06:07:21.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-01-05T16:34:46.000Z (about 1 month ago)
- Last Synced: 2025-01-09T09:11:26.672Z (29 days ago)
- Topics: bash, command-line, command-line-tool, fish, linux, neovim, python3, tmux, vim, zsh
- Language: Python
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# key2pane
[](https://github.com/BartSte/tmux-key2pane/actions/workflows/test.yml)
Sends a sequence of keys to any tmux pane, based on the pane's current command.
## TODO:
- When running `key2pane` from the cli, it treats the current pane as `python`
instead of the shell. This may be expected, but is confusing for the user.
- When enabling --reset from the cli nothing happens. When enabling it from the
config file, it results in a KeyboardInterrupt.
## Contents
- [Contents](#contents)
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)
## Introduction
`key2pane` is a tmux plugin for sending a sequence of keys to a tmux pane, based
on the target pane's command that is running. Which keys are sent can be
configured in a json file:
```json
{
// Other settings ...
"actions": [
{
"regex": "bash|zsh|fish",
"keys": ["echo 'Hello, World!'", "Enter"]
}
]
}
```
When the command of the target pane matches the regex, the keys are sent to the
pane. In this case, the command: `echo 'Hello, World!'` is sent to the pane, and
then the `Enter` key is sent.
** TODO: Add a demo gif here **
## Installation
Install `key2pane` using pip:
```sh
pip install key2pane
```
which will install the `key2pane` command.
## Usage
Expanding on the example in the [introduction](#introduction), consider the
following configuration:
```json
{
// Other settings ...
"session": "test",
"window": 0,
"index": 0,
"actions": [
{
"regex": "bash|zsh|fish",
"keys": ["echo '{0} {1}'", "Enter"]
}
]
}
```
When we run the `key2pane foo bar` command, the following will happen:
- For the session `test`, window `0`, and pane `0`, the command is retrieved.
- If this command matches the regex `bash|zsh|fish`, the keys `echo '{0} {1}'`
are selected.
- The placeholders `{0}` and `{1}` are replaced with the positional arguments
`foo` and `bar`.
- The formatted keys are send to the pane, using `tmux send-keys`. After that,
the `Enter` key is sent.
- As a result, the command `echo 'foo bar'` is executed in the pane.
Note that the following may occur, which is expected behavior but may cause some
confusion:
You run the following command from window 0, pane 0:
```sh
key2pane -w 0 -p 0 foo bar
```
The command is executed and send to the same tmux pane. Which is fine, but you
might the following output:
```sh
ERROR:root:No action found for command python3
```
This is expected behavior because during the execution of the `key2pane` command
the command is `python3`, and not your shell anymore. If you want the command of
the pane to remain the shell, you can use:
```sh
key2pane -w 0 -p 0 --reset foo bar &
```
which will execute the command in a subshell, and thus not changing the command
of the pane.
## Configuration
When you run the `key2pane` command for the first time, no configuration file
is exists yet. You need to create a configuration file in the default location
`~/.config/key2pane/config.json`, or specify a different location using the
`--config` option. As a starting point, you can use the following example:
```json
{
"session": null,
"window": null,
"index": null,
"reset": false,
"logfile": null,
"loglevel": null,
"actions": [
{
"regex": "bash|zsh|fish",
"keys": ["echo '{0}'", "Enter"]
},
{
"regex": "python[0-9]*",
"keys": ["print('{0}')", "Enter"]
}
]
}
```
Since comments are not allowed in JSON, notes are placed here:
- **session**: the session name. Default: current session.
- **window**: the window index. Default: current window.
- **index**: the pane index. Default: current pane.
- **reset**: send a Ctrl-C before sending the keys. Default: false
- **logfile**: the log file. Default: ~/.local/state/key2pane/key2pane.log
- **loglevel**: the log level. Default: WARNING
- **actions**: a list of actions, containing a `regex`, and a `keys` property.
The `keys` are send to the target pane when the `regex` matches the command
of the target pane.
## Troubleshooting
If you encounter any issues, please report them on the issue tracker at:
[tmux-key2pane issues](https://github.com/BartSte/tmux-key2pane/issues)
## Contributing
Contributions are welcome! Please see [CONTRIBUTING](./CONTRIBUTING.md) for
more information.
## License
Distributed under the [MIT License](./LICENCE).