https://github.com/sayanarijit/command-mode.xplr
The missing command mode for xplr
https://github.com/sayanarijit/command-mode.xplr
Last synced: 7 months ago
JSON representation
The missing command mode for xplr
- Host: GitHub
- URL: https://github.com/sayanarijit/command-mode.xplr
- Owner: sayanarijit
- License: mit
- Created: 2021-09-02T08:46:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-18T13:06:02.000Z (about 2 years ago)
- Last Synced: 2025-03-19T05:56:12.790Z (7 months ago)
- Language: Lua
- Homepage: https://xplr.stck.me/post/28557/Forget-key-bindings-and-get-yourself-a-command-mode
- Size: 54.7 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
https://user-images.githubusercontent.com/11632726/174449444-2e13c1d7-7c1b-4dea-a2a8-13f193d8df8d.mp4
# command-mode.xplr
This plugin acts like a library to help you define custom commands to perform
actions.
## Why
[xplr](https://github.com/sayanarijit/xplr) has no concept of commands. By default, it requires us to map keys directly to a list of [messages](https://arijitbasu.in/xplr/en/message.html).
While for the most part this works just fine, sometimes it gets difficult to remember which action is mapped to which key inside which mode. Also, not every action needs to be bound to some key.
In short, sometimes, it's much more convenient to define and enter commands to perform certain actions than trying to remember key bindings.
## Installation
### Install manually
- Add the following line in `~/.config/xplr/init.lua`
```lua
local home = os.getenv("HOME")
package.path = home
.. "/.config/xplr/plugins/?/init.lua;"
.. home
.. "/.config/xplr/plugins/?.lua;"
.. package.path
```
- Clone the plugin
```bash
mkdir -p ~/.config/xplr/plugins
git clone https://github.com/sayanarijit/command-mode.xplr ~/.config/xplr/plugins/command-mode
```
- Require the module in `~/.config/xplr/init.lua`
```lua
require("command-mode").setup()
-- Or
require("command-mode").setup{
mode = "default",
key = ":",
remap_action_mode_to = {
mode = "default",
key = ";",
}
}
-- Type `:` to enter command mode
```
## Usage
Examples are taken from [here](https://xplr.dev/en/environment-variables-and-pipes#example-using-environment-variables-and-pipes) and [here](https://xplr.dev/en/lua-function-calls#example-using-lua-function-calls).
```lua
-- Assuming you have installed and setup the plugin
local m = require("command-mode")
-- Setup with default settings
m.setup()
-- Type `:hello-lua` and press enter to know your location
local hello_lua = m.cmd("hello-lua", "Enter name and know location")(function(app)
print("What's your name?")
local name = io.read()
local greeting = "Hello " .. name .. "!"
local message = greeting .. " You are inside " .. app.pwd
return {
{ LogSuccess = message },
}
end)
-- Type `:hello-bash` and press enter to know your location
local hello_bash = m.silent_cmd("hello-bash", "Enter name and know location")(
m.BashExec [===[
echo "What's your name?"
read name
greeting="Hello $name!"
message="$greeting You are inside $PWD"
"$XPLR" -m "LogSuccess: %q" "$message"
]===]
)
-- Bind `:hello-lua` to key `h`
hello_lua.bind("default", "h")
-- or xplr.config.modes.builtin.default.key_bindings.on_key.h = hello_lua.action
-- Bind `:hello-bash` to key `H`
hello_bash.bind(xplr.config.modes.builtin.default, "H")
-- or xplr.config.modes.builtin.default.key_bindings.on_key.H = hello_bash.action
```
**NOTE:** To define non-interactive commands, use `silent_cmd` to avoid the flickering of screen.
## Features
- Tab completion
- Command history navigation
- Press `?` to list commands
- Press `!` to spawn shell
- Easily map keys to commands
- Shortcut for `BashExec` and `BashExecSilently` messages.
- Interactive UI