{"id":24556054,"url":"https://github.com/lost-melody/tmux-command-palette","last_synced_at":"2025-03-16T17:46:02.663Z","repository":{"id":262132492,"uuid":"886298729","full_name":"lost-melody/tmux-command-palette","owner":"lost-melody","description":"A tmux plugin that popups a palette for key bindings to choose from","archived":false,"fork":false,"pushed_at":"2024-12-04T04:02:29.000Z","size":56,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T04:36:44.799Z","etag":null,"topics":["command-palette","tmux","tmux-plugins","tpm","tpm-plugin"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lost-melody.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null}},"created_at":"2024-11-10T17:45:50.000Z","updated_at":"2024-12-30T21:56:03.000Z","dependencies_parsed_at":"2024-11-10T18:39:42.023Z","dependency_job_id":"91ca325b-9c52-4b52-baf1-e8cfe9e372cc","html_url":"https://github.com/lost-melody/tmux-command-palette","commit_stats":null,"previous_names":["lost-melody/tmux-command-palette"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lost-melody%2Ftmux-command-palette","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lost-melody%2Ftmux-command-palette/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lost-melody%2Ftmux-command-palette/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lost-melody%2Ftmux-command-palette/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lost-melody","download_url":"https://codeload.github.com/lost-melody/tmux-command-palette/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243910714,"owners_count":20367538,"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":["command-palette","tmux","tmux-plugins","tpm","tpm-plugin"],"created_at":"2025-01-23T04:36:54.285Z","updated_at":"2025-03-16T17:46:02.628Z","avatar_url":"https://github.com/lost-melody.png","language":"Shell","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"# Tmux Command Palette\n\n## Features\n\n_Tmux Command Palette_ is actually _Keybinding Palette_ despite its name.\n\n- Pressing `prefix` then `?` shows the palette for key table _prefix_.\n- Pressing `prefix` then `BSpace` shows the palette for key table _root_.\n- Pressing `?` in `copy-mode` shows the palette for key table _copy-mode_.\n- Pressing `prefix` then `M-m` shows the palette for a custom command list.\n\n## Screenshots\n\n\u003cdetails\u003e\n\u003csummary\u003eKeybinding Palette\u003c/summary\u003e\n\n![tmux-cmdpalette01.png](https://i.postimg.cc/TPVRms29/tmux-cmdpalette01.png)\n![tmux-cmdpalette02.png](https://i.postimg.cc/mZXTQC40/tmux-cmdpalette02.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eCommand Palette\u003c/summary\u003e\n\n![tmux-cmdpalette03.png](https://i.postimg.cc/7YjDR4f9/tmux-cmdpalette03.png)\n\n\u003c/details\u003e\n\n## Installation\n\nRequirements:\n\n- [tmux](https://github.com/tmux/tmux) `\u003e=3.3`\n- [fzf](https://github.com/junegunn/fzf) `\u003e=0.24.0`\n\n### TPM (Tmux Plugin Manager)\n\n- Install [tpm](https://github.com/tmux-plugins/tpm).\n- Add this plugin to the list of TPM plugins in `~/.tmux.conf`:\n  ```tmux\n  set -g @plugin 'lost-melody/tmux-command-palette'\n  ```\n- Press `prefix` then `I` (in tmux) to install it.\n\n### Manually\n\nOptionally, you may clone this repo and simply run the initialization script in `~/.tmux.conf`:\n\n```tmux\nrun-shell $PATH_TO_CMDPALETTE/init.tmux\n```\n\n## Configuration\n\n### Keybindings Table\n\nSet key tables that command palette should bind keys for:\n\n```tmux\n# leave empty for all tables\nset -g @cmdpalette-tables 'root,prefix,copy-mode-vi'\n```\n\nUse custom keys for key tables:\n\n```tmux\n# 'prefix ?' -\u003e cmdpalette 'prefix', defaults to '?'\nset -g @cmdpalette-key-prefix 'prefix ?'\n# 'prefix BSpace' -\u003e cmdpalette 'root'\nset -g @cmdpalette-key-root 'prefix BSpace'\n# 'copy-mode-vi C-/' -\u003e cmdpalette 'copy-mode-vi'\nset -g @cmdpalette-key-copy-mode-vi 'copy-mode-vi C-/'\n```\n\n### Custom Command List\n\nCommand list is a shell script that is sourced by the palette entry file, where we register a series of tmux commands.\n\nFirst create the shell script:\n\n```sh\nmkdir -p ~/.config/tmux-command-palette\ntouch ~/.config/tmux-command-palette/commands.sh\n```\n\nThen register commands in the file:\n\n```sh\n# commands.sh\ntmux_cmd --icon \"󰑕 \" --note \"Rename session\" -- \\\n    command-prompt -p \"session name:\" \"rename-session %1\"\nshell_cmd --icon \"󰈹 \" --note \"Launch firefox\" -- \\\n    firefox\nlocal editor=\"${EDITOR:-\"vim\"}\"\npopup_cmd --icon \"󰤌 \" --note \"Edit this list of commands\" --flags \"-E\" -- \\\n    ${editor} \"${cmdfile}\"\n```\n\nWith `tmux_cmd`, `shell_cmd`, `popup_cmd` defined in the entry file:\n\n```txt\ntmux_cmd [--note string] [--icon string] -- [command]\nshell_cmd [--note string] [--icon string] -- [command]\npopup_cmd [--note string] [--icon string] -- [command]\n```\n\nCustom key binding for raising the command palette:\n\n```tmux\n# same to the script file name, defaults to 'commands'\nset -g @cmdpalette-cmdlists 'commands'\n# 'prefix P' -\u003e cmdpalette 'commands'\nset -g @cmdpalette-cmd-commands 'prefix P'\n```\n\nNow we can press `prefix` then `P` and choose our commands from the palette.\n\n## Similar Projects\n\n- [tmux-which-key](https://github.com/alexwforsythe/tmux-which-key)\n- [tmux-menus](https://github.com/jaclu/tmux-menus)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flost-melody%2Ftmux-command-palette","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flost-melody%2Ftmux-command-palette","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flost-melody%2Ftmux-command-palette/lists"}