Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TheSast/tmux-keylocker
Lock away your tmux keybinds temporarely.
https://github.com/TheSast/tmux-keylocker
shell tmux tmux-plugin tmux-plugins tpm
Last synced: 3 months ago
JSON representation
Lock away your tmux keybinds temporarely.
- Host: GitHub
- URL: https://github.com/TheSast/tmux-keylocker
- Owner: TheSast
- License: other
- Created: 2023-07-23T12:58:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-18T13:21:02.000Z (9 months ago)
- Last Synced: 2024-04-24T04:21:37.135Z (6 months ago)
- Topics: shell, tmux, tmux-plugin, tmux-plugins, tpm
- Language: Shell
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-tmux - tmux-keylocker
README
Tmux Keylocker
=======
This tmux [tpm](https://github.com/tmux-plugins/tpm) plugin allows you to lock your keybinds away for a while, until you need to use them again
Usage
-----
Either use the [configured bindings](#configuration) or run `tmux toggle-mappings` in you terminal to lock away all (other) bindings until you run it again.
You can use `tmux lock-mappings` and `tmux unlock-mappings` if you want to separate those behaviours.
Installation
------------
You can install this plugin through [tpm](https://github.com/tmux-plugins/tpm):
1. Install [tpm](https://github.com/tmux-plugins/tpm) (duh)
2. Add this line to your `tmux.conf`:
```tmux
set -g @plugin 'thesast/tmux-keylocker'
```
3. Install the plugin with `I`, unless you changed `@tpm-install`, in which case you should use the keybind you set.
Configuration
-------------
This plugins offers three options to be set in your `tmux.conf` with these defaults:
```tmux
set -g @keylocker-toggle-bind 'C-g'
set -g @keylocker-lock-bind 'None'
set -g @keylocker-unlock-bind 'None'
```
to remove the pre-set binding set the related option option to `None`.
Note that these are a simple wrapper binds over the command aliases provided by the plugin.
You may also want to set your status bar to show whether or not your mappings are currently locked using the tmux option set by this plugin.
`@keylocker-status` will contain either the path to the file where the currently locked mappings are stored or `0`.
Here are some examples with and without using a script:
```tmux
set -g status-right "#{?@keylocker-status,#[fg=color255]#[bg=color208] LOCKED ,#[fg=color0]#[bg=color101] UNLOCKED }"
```
```tmux
set -g status-right "#(~/.config/tmux/scripts/status/keylocker.bash)"
```
```bash
#!/usr/bin/env bash
# script located in ~/.config/tmux/scripts/status/keylocker.bash
MAPPINGS="$(tmux show-option -gqv "@keylocker-status")"
[ "$MAPPINGS" = "0" ] &&
echo "#[fg=color0]#[bg=color101] UNLOCKED " ||
echo "#[fg=color255]#[bg=color208] LOCKED $(cat $MAPPINGS | wc -l) MAPPINGS "
```
Other plugins
-------------
You might also like these plugins:
- [tmux-nav-master](https://github.com/TheSast/tmux-nav-master) - Easy cross-navigation between tmux and other terminal applications.
- [tmux-transient-status](https://github.com/TheSast/tmux-transient-status) - Automatically make your tmux status bar vanish when unneded.
Licence
-------
[MIT and Apache 2.0](COPYRIGHT.md)