editprompt 1.1.1 → 1.3.0

package/README.md

@@ -19,7 +19,6 @@ A CLI tool that lets you write prompts for CLI tools using your favorite text ed
 - **💬 Quote and Reply**: Collect multiple text selections and reply to specific parts of AI responses
 - **📝 Multi-line Commands**: Complex SQL queries, JSON payloads, and structured prompts
 
-
 ## ✨ Features
 
 - 🖊️ **Editor Integration**: Use your preferred text editor to write prompts
@@ -29,7 +28,6 @@ A CLI tool that lets you write prompts for CLI tools using your favorite text ed
 - 📋 **Quote Buffering**: Collect text selections and send them as quoted replies
 - 📋 **Clipboard Fallback**: Automatically copies to clipboard if sending fails
 
-
 ## 📦 Installation
 
 ```bash
@@ -40,6 +38,10 @@ npm install -g editprompt
 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).
+
 ## 🚀 Usage
 
 editprompt supports three main workflows to fit different use cases:
@@ -93,7 +95,6 @@ For replying to specific parts of AI responses:
 
 Perfect for addressing multiple points in long AI responses.
 
-
 ## ⚙️ Setup & Configuration
 
 ### Basic Setup
@@ -123,7 +124,6 @@ bind -n M-q run-shell '\
     "editprompt open --editor nvim --always-copy --target-pane #{pane_id}"'
 ```
 
-
 ### WezTerm Integration
 
 ```lua
@@ -169,7 +169,6 @@ bind -n M-q run-shell '\
 
 **Note:** The `-lc` flag ensures your shell loads the full login environment, making `editprompt` available in your PATH.
 
-
 ### 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.
@@ -193,51 +192,15 @@ editprompt input --auto-send --send-key "C-m" -- "your content here"
 This sends the content to the target pane (or clipboard) while keeping your editor open, so you can continue editing and send multiple times.
 
 **Options:**
+
 - `--auto-send`: Automatically sends the content and returns focus to your editor pane (requires multiplexer)
 - `--send-key <key>`: Customize the key to send after content (requires `--auto-send`)
   - tmux format: `Enter` (default), `C-a`, etc.
   - WezTerm format: `\r` (default), `\x01`, etc.
 
-#### Neovim Integration Example
-
-You can set up a convenient keybinding to send your buffer content:
-
-```lua
--- Send buffer content while keeping the editor open
-if vim.env.EDITPROMPT then
-    vim.keymap.set("n", "<Space>x", function()
-        vim.cmd("update")
-        -- Get buffer content
-        local lines = vim.api.nvim_buf_get_lines(0, 0, -1, false)
-        local content = table.concat(lines, "\n")
-
-        -- Execute editprompt command
-        vim.system(
-            { "editprompt", "input", "--", content },
-            { text = true },
-            function(obj)
-                vim.schedule(function()
-                    if obj.code == 0 then
-                        -- Clear buffer on success
-                        vim.api.nvim_buf_set_lines(0, 0, -1, false, {})
-                        vim.cmd("silent write")
-                    else
-                        -- Show error notification
-                        vim.notify("editprompt failed: " .. (obj.stderr or "unknown error"), vim.log.levels.ERROR)
-                    end
-                end)
-            end
-        )
-    end, { silent = true, desc = "Send buffer content to editprompt" })
-end
-```
+#### Neovim Integration
 
-**Usage:**
-1. Open editprompt using the tmux/wezterm keybinding
-2. Write your prompt in the editor
-3. Press `<Space>x` to send the content to the target pane
-4. The buffer is automatically cleared on success
-5. Continue editing to send more content
+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).
 
 ### Quote Workflow Setup
 
@@ -250,6 +213,7 @@ bind-key -T copy-mode-vi C-e { send-keys -X pipe "editprompt collect --target-pa
 ```
 
 **Usage:**
+
 1. Enter tmux copy mode (`prefix + [`)
 2. Select text using vi-mode keybindings
 3. Press `Ctrl-e` to add the selection as a quote
@@ -290,6 +254,7 @@ return {
 ```
 
 **Usage:**
+
 1. Select text in WezTerm (by dragging with mouse or using copy mode)
 2. Press `Ctrl-e` to add the selection as a quote
 3. Repeat to collect multiple quotes
@@ -306,6 +271,7 @@ editprompt dump
 This copies all collected quotes to the clipboard and clears the buffer, ready for your reply.
 
 **Complete workflow:**
+
 1. AI responds with multiple points
 2. Select each point in copy mode and press `Ctrl-e`
 3. Open your editor pane and run `editprompt dump`
@@ -313,6 +279,7 @@ This copies all collected quotes to the clipboard and clears the buffer, ready f
 5. Send to AI
 
 **How quote buffering works:**
+
 - **tmux**: Quotes are stored in pane variables, automatically cleaned up when the pane closes
 - **WezTerm**: Quotes are stored in a configuration file associated with the pane
 - Text is intelligently processed: removes common indentation, handles line breaks smartly
@@ -333,53 +300,32 @@ editprompt register --target-pane %1 --target-pane %2
 
 The content will be sent sequentially to all specified panes. This is useful when you want to send the same prompt to multiple CLI sessions.
 
-#### Neovim Integration Example
+### Prompt Stash
 
-You can set up a convenient keybinding to capture your quote content:
-```lua
-vim.keymap.set("n", "<Space>X", function()
-  vim.cmd("update")
-
-  vim.system({ "editprompt", "dump" }, { text = true }, function(obj)
-    vim.schedule(function()
-      if obj.code == 0 then
-        vim.cmd("silent write")
-        -- Split stdout by lines
-        local output_lines = vim.split(obj.stdout, "\n")
-
-        local lines = vim.api.nvim_buf_get_lines(0, 0, -1, false)
-        local is_empty = #lines == 1 and lines[1] == ""
-
-        if is_empty then
-          -- If empty, overwrite from the beginning
-          vim.api.nvim_buf_set_lines(0, 0, -1, false, output_lines)
-          vim.cmd("normal 2j")
-        else
-          -- If not empty, append to the end
-          table.insert(output_lines, 1, "")
-          local line_count = vim.api.nvim_buf_line_count(0)
-          vim.api.nvim_buf_set_lines(
-            0,
-            line_count,
-            line_count,
-            false,
-            output_lines
-          )
-          vim.cmd("normal 4j")
-        end
-
-        vim.cmd("silent write")
-      else
-        vim.notify(
-          "editprompt failed: " .. (obj.stderr or "unknown error"),
-          vim.log.levels.ERROR
-        )
-      end
-    end)
-  end)
-end, { silent = true, desc = "Capture from editprompt quote mode" })
+Store prompts temporarily for later use, similar to `git stash`. This is useful when you want to save a prompt idea and use it later.
+
+```bash
+# Save a prompt to stash (must be run from editor pane)
+editprompt stash push -- "your prompt here"
+
+# List all stashed prompts (JSON output)
+editprompt stash list
+
+# Get the latest stashed prompt (outputs to stdout)
+editprompt stash apply
+
+# Get a specific stashed prompt by key
+editprompt stash apply --key "2025-01-07T12:34:56.789Z"
+
+# Remove the latest stashed prompt
+editprompt stash drop
+
+# Get and remove the latest stashed prompt (apply + drop)
+editprompt stash pop
 ```
 
+**Note:** The stash commands must be run from within an editprompt editor session (where `EDITPROMPT=1` is set). Stash data is associated with the target pane and persisted using the Conf library.
+
 ### Environment Variables
 
 #### Editor Selection
@@ -392,18 +338,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.
-
-**Example: Neovim Configuration**
-
-```lua
--- In your Neovim config (e.g., init.lua)
-if vim.env.EDITPROMPT then
-  vim.opt.wrap = true
-  -- Load a specific colorscheme
-  vim.cmd('colorscheme blue')
-end
-```
+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).
 
 #### Custom Environment Variables
 
@@ -423,3 +358,42 @@ editprompt open --env NVIM_CONFIG=minimal
 #### Target Pane Environment Variable
 
 When using the send-without-closing feature or dump, editprompt sets `EDITPROMPT_TARGET_PANE` to the target pane ID. This is automatically used by `editprompt input` and `editprompt dump` commands.
+
+### Logging Options
+
+editprompt uses structured logging via [LogTape](https://logtape.org/). The following flags are available on all subcommands:
+
+| Flag                | Description                                |
+| ------------------- | ------------------------------------------ |
+| `--quiet` / `-q`    | Suppress all log output                    |
+| `--verbose` / `-v`  | Enable debug-level log output              |
+| `--log-file <path>` | Write logs to the specified file (appends) |
+
+You can also configure logging via environment variables:
+
+| Environment Variable   | Description                                          |
+| ---------------------- | ---------------------------------------------------- |
+| `EDITPROMPT_LOG_FILE`  | Path to log file (same as `--log-file`)              |
+| `EDITPROMPT_LOG_LEVEL` | Log level (e.g. `debug`, `info`, `warning`, `error`) |
+
+**Log level resolution priority:**
+
+1. `--quiet` → suppresses all logs
+2. `--verbose` → sets level to `debug`
+3. `EDITPROMPT_LOG_LEVEL` → uses the specified level
+4. Default: `info`
+
+### Send-Key Delay
+
+When using `--auto-send` with `editprompt input`, a delay is inserted before sending the key to allow the target process to finish processing the content.
+
+| Environment Variable        | Description                                  | Default |
+| --------------------------- | -------------------------------------------- | ------- |
+| `EDITPROMPT_SEND_KEY_DELAY` | Delay in milliseconds before sending the key | `1000`  |
+
+**Auto-detection:** editprompt automatically adjusts the delay based on content:
+
+- **Content with image paths** → uses `EDITPROMPT_SEND_KEY_DELAY` (default: `1000` ms)
+- **Content without image paths** → uses `200` ms
+
+Supported image extensions: `.png`, `.webp`, `.avif`, `.jpg`/`.jpeg`, `.gif` (case-insensitive)