editprompt 1.8.1 → 2.0.0

package/README.md

@@ -22,7 +22,8 @@ A CLI tool that lets you write prompts for CLI tools using your favorite text ed
 ## ✨ Features
 
 - 🖊️ **Editor Integration**: Use your preferred text editor to write prompts
-- 🖥️ **Multiplexer Support**: Send prompts directly to tmux, WezTerm, Herdr, or Rex sessions
+- 🖥️ **Multiplexer Support**: Send prompts directly to tmux, WezTerm, Herdr, niwaterm, or Rex sessions
+- 🧩 **Custom Backends**: Add any other terminal with a CLI from your configuration file
 - 🖥️ **Universal Terminal Support**: Works with any terminal via clipboard - no multiplexer required
 - 📤 **Send Without Closing**: Iterate on prompts without closing your editor
 - 📋 **Quote Buffering**: Collect text selections and send them as quoted replies
@@ -40,7 +41,7 @@ npx editprompt
 
 ### Neovim Plugin
 
-For Neovim users, [editprompt.nvim](https://github.com/eetann/editprompt.nvim) provides easy integration. For manual configuration, see [docs/neovim.md](docs/neovim.md).
+For Neovim users, [editprompt.nvim](https://github.com/eetann/editprompt.nvim) provides easy integration.
 
 ## 🚀 Usage
 
@@ -273,6 +274,22 @@ Name the editor with `--editor`. A terminal Rex starts gets the login shell's en
 
 Inside a Rex pane, editprompt automatically selects the Rex backend when `REX_BLOCK` is set. Running tmux inside a Rex pane sets both, and Rex wins, so pass `--mux tmux` or set `EDITPROMPT_MUX` for that case.
 
+### Other Terminals (Custom Backends)
+
+Any other terminal or multiplexer with a command-line interface can be added in `~/.config/editprompt/config.toml`, without waiting for editprompt to support it:
+
+```toml
+[backends.mytty]
+detect = { env = "MYTTY_PANE_ID" }
+currentPane = { env = "MYTTY_PANE_ID" }
+paneExists = 'mytty pane exists "$EDITPROMPT_PANE"'
+focus = 'mytty pane focus "$EDITPROMPT_PANE"'
+sendText = 'mytty send-text --pane "$EDITPROMPT_PANE"'
+sendKey = 'mytty send-key --pane "$EDITPROMPT_PANE" "$EDITPROMPT_KEY"'
+```
+
+Then select it with `--mux mytty`, `EDITPROMPT_MUX=mytty`, or let `detect` pick it. See [docs/backends.md](docs/backends.md) for every option, including the commands that enable `editprompt toggle`.
+
 ### Editor Integration (Send Without Closing)
 
 While editprompt is running, you can send content to the target pane or clipboard without closing the editor. This allows you to iterate quickly on your prompts.
@@ -307,7 +324,7 @@ This sends the content to the target pane (or clipboard) while keeping your edit
 
 #### Neovim Integration
 
-For Neovim users, we recommend using [editprompt.nvim](https://github.com/eetann/editprompt.nvim) for easy setup. For manual configuration, see [docs/neovim.md](docs/neovim.md).
+For Neovim users, we recommend using [editprompt.nvim](https://github.com/eetann/editprompt.nvim) for easy setup.
 
 ### Key Sending (press)
 
@@ -509,7 +526,7 @@ editprompt respects the following editor priority:
 
 #### EDITPROMPT Environment Variable
 
-editprompt automatically sets `EDITPROMPT=1` when launching your editor. This allows you to detect when your editor is launched by editprompt and enable specific configurations or plugins. For Neovim integration examples, see [docs/neovim.md](docs/neovim.md).
+editprompt automatically sets `EDITPROMPT=1` when launching your editor. This allows you to detect when your editor is launched by editprompt and enable specific configurations or plugins.
 
 #### Custom Environment Variables