{"id":13740580,"url":"https://github.com/TheSast/tmux-keylocker","last_synced_at":"2025-05-08T20:31:58.008Z","repository":{"id":183231758,"uuid":"669793871","full_name":"TheSast/tmux-keylocker","owner":"TheSast","description":"Lock away your tmux keybinds temporarely.","archived":false,"fork":false,"pushed_at":"2024-02-18T13:21:02.000Z","size":44,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-04T04:06:44.805Z","etag":null,"topics":["shell","tmux","tmux-plugin","tmux-plugins","tpm"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheSast.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-07-23T12:58:04.000Z","updated_at":"2024-05-31T09:40:39.000Z","dependencies_parsed_at":"2024-02-16T01:53:10.928Z","dependency_job_id":null,"html_url":"https://github.com/TheSast/tmux-keylocker","commit_stats":null,"previous_names":["thesast/tmux-locker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSast%2Ftmux-keylocker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSast%2Ftmux-keylocker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSast%2Ftmux-keylocker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSast%2Ftmux-keylocker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheSast","download_url":"https://codeload.github.com/TheSast/tmux-keylocker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224765514,"owners_count":17366131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["shell","tmux","tmux-plugin","tmux-plugins","tpm"],"created_at":"2024-08-03T04:00:50.076Z","updated_at":"2024-11-15T10:30:51.912Z","avatar_url":"https://github.com/TheSast.png","language":"Shell","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"Tmux Keylocker\n=======\n\nThis 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\n\u003c!--\nPreview\n-------\n\n![img/preview.gif](img/preview.gif)   --\u003e\n\nUsage\n-----\n\nEither use the [configured bindings](#configuration) or run `tmux toggle-mappings` in you terminal to lock away all (other) bindings until you run it again.\nYou can use `tmux lock-mappings` and `tmux unlock-mappings` if you want to separate those behaviours.\n\nInstallation\n------------\n\nYou can install this plugin through [tpm](https://github.com/tmux-plugins/tpm):\n1. Install [tpm](https://github.com/tmux-plugins/tpm) (duh)  \n2. Add this line to your `tmux.conf`:  \n```tmux\nset -g @plugin 'thesast/tmux-keylocker'\n```\n3. Install the plugin with `\u003cprefix\u003eI`, unless you changed `@tpm-install`, in which case you should use the keybind you set.\n\nConfiguration\n-------------\n\nThis plugins offers three options to be set in your `tmux.conf` with these defaults:\n```tmux\nset -g @keylocker-toggle-bind 'C-g'\nset -g @keylocker-lock-bind 'None'\nset -g @keylocker-unlock-bind 'None'\n```\nto remove the pre-set binding set the related option option to `None`.\n\nNote that these are a simple wrapper binds over the command aliases provided by the plugin.\n\nYou 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.\n`@keylocker-status` will contain either the path to the file where the currently locked mappings are stored or `0`.\n\nHere are some examples with and without using a script:\n```tmux\nset -g status-right \"#{?@keylocker-status,#[fg=color255]#[bg=color208] LOCKED ,#[fg=color0]#[bg=color101] UNLOCKED }\"\n```\n![img/status-simple-locked.png](img/status-simple-locked.png)\n![img/status-unlocked.png](img/status-unlocked.png)\n```tmux\nset -g status-right \"#(~/.config/tmux/scripts/status/keylocker.bash)\"\n```\n```bash\n#!/usr/bin/env bash\n# script located in ~/.config/tmux/scripts/status/keylocker.bash\nMAPPINGS=\"$(tmux show-option -gqv \"@keylocker-status\")\"\n[ \"$MAPPINGS\" = \"0\" ] \u0026\u0026\n  echo \"#[fg=color0]#[bg=color101] UNLOCKED \" ||\n  echo \"#[fg=color255]#[bg=color208] LOCKED $(cat $MAPPINGS | wc -l) MAPPINGS \"\n\n```\n![img/status-script-locked.png](img/status-script-locked.png)\n\nOther plugins\n-------------\n\nYou might also like these plugins:\n\n  - [tmux-nav-master](https://github.com/TheSast/tmux-nav-master) - Easy cross-navigation between tmux and other terminal applications. \n\n  - [tmux-transient-status](https://github.com/TheSast/tmux-transient-status) - Automatically make your tmux status bar vanish when unneded. \n\nLicence\n-------\n\n[MIT and Apache 2.0](COPYRIGHT.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheSast%2Ftmux-keylocker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTheSast%2Ftmux-keylocker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheSast%2Ftmux-keylocker/lists"}