rubber-ducky 1.3.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

rubber_ducky-1.4.0.dist-info/METADATA

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: rubber-ducky
+Version: 1.4.0
+Summary: Quick CLI do-it-all tool. Use natural language to spit out bash commands
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: fastapi>=0.115.11
+Requires-Dist: ollama>=0.6.0
+Requires-Dist: openai>=1.60.2
+Requires-Dist: prompt-toolkit>=3.0.48
+Requires-Dist: rich>=13.9.4
+Requires-Dist: termcolor>=2.5.0
+Dynamic: license-file
+
+# Rubber Ducky
+
+Rubber Ducky is an inline terminal companion that turns natural language prompts into runnable shell commands. Paste multi-line context, get a suggested command, and run it without leaving your terminal.
+
+## Quick Start
+
+| Action | Command |
+| --- | --- |
+| Install globally | `uv tool install rubber-ducky` |
+| Run once | `uvx rubber-ducky -- --help` |
+| Local install | `uv pip install rubber-ducky` |
+
+Requirements:
+- [Ollama](https://ollama.com) running locally
+- Model available via Ollama (default: `qwen3-coder:480b-cloud`, install with `ollama pull qwen3-coder:480b-cloud`)
+
+## Usage
+
+```
+ducky                      # interactive inline session
+ducky --directory src      # preload code from a directory
+ducky --model qwen3        # use a different Ollama model
+ducky --local              # use local models with gemma2:9b default
+ducky --poll log-crumb     # start polling mode for a crumb
+```
+
+Both `ducky` and `rubber-ducky` executables map to the same CLI, so `uvx rubber-ducky -- <args>` works as well.
+
+### Inline Session (default)
+
+Launching `ducky` with no arguments opens the inline interface:
+- **Enter** submits; **Ctrl+J** inserts a newline (helpful when crafting multi-line prompts). Hitting **Enter on an empty prompt** reruns the latest suggested command; if none exists yet, it explains the most recent shell output.
+- **Ctrl+R** re-runs the last suggested command.
+- **Ctrl+S** copies the last suggested command to clipboard.
+- Prefix any line with **`!`** (e.g., `!ls -la`) to run a shell command immediately.
+- Arrow keys browse prompt history, backed by `~/.ducky/prompt_history`.
+- Every prompt, assistant response, and executed command is logged to `~/.ducky/conversation.log`.
+- Press **Ctrl+D** on an empty line to exit.
+- Non-interactive runs such as `cat prompt.txt | ducky` print one response (and suggested command) before exiting; if a TTY is available you'll be asked whether to run the suggested command immediately.
+- If `prompt_toolkit` is unavailable in your environment, Rubber Ducky falls back to a basic input loop (no history or shortcuts); install `prompt-toolkit>=3.0.48` to unlock the richer UI.
+
+`ducky --directory <path>` streams the contents of the provided directory to the assistant the next time you submit a prompt (the directory is read once at startup).
+
+### Model Management
+
+Rubber Ducky now supports easy switching between local and cloud models:
+- **`/model`** - Interactive model selection between local and cloud models
+- **`/local`** - List and select from local models (localhost:11434)
+- **`/cloud`** - List and select from cloud models (ollama.com)
+- Last used model is automatically saved and loaded on startup
+- Type **`esc`** during model selection to cancel
+
+### Additional Commands
+
+- **`/help`** - Show all available commands and shortcuts
+- **`/crumbs`** - List all available crumbs (default and user-created)
+- **`/clear`** or **`/reset`** - Clear conversation history
+- **`/poll <crumb>`** - Start polling session for a crumb
+- **`/poll <crumb> -i <interval>`** - Start polling with custom interval
+- **`/poll <crumb> -p <prompt>`** - Start polling with custom prompt
+- **`/stop-poll`** - Stop current polling session
+- **`/run`** or **`:run`** - Re-run the last suggested command
+
+## Crumbs
+
+Crumbs are simple scripts that can be executed within Rubber Ducky. They are stored in `~/.ducky/crumbs/` (for user crumbs) and shipped with the package (default crumbs).
+
+Rubber Ducky ships with the following default crumbs:
+
+| Crumb | Description |
+|-------|-------------|
+| `git-status` | Show current git status and provide suggestions |
+| `git-log` | Show recent commit history with detailed information |
+| `recent-files` | Show recently modified files in current directory |
+| `disk-usage` | Show disk usage with highlights |
+| `system-health` | Show CPU, memory, and system load metrics |
+| `process-list` | Show running processes with analysis |
+
+**Tip:** Run `/crumbs` in interactive mode to see all available crumbs with descriptions and polling status.
+
+To use a crumb, simply mention it in your prompt:
+```
+Can you use the git-status crumb to see what needs to be committed?
+```
+
+**Note:** User-defined crumbs (in `~/.ducky/crumbs/`) override default crumbs with the same name.
+
+### Creating Crumbs
+
+To create a new crumb:
+
+1. Create a new directory in `~/.ducky/crumbs/` with your crumb name
+2. Add an `info.txt` file with metadata:
+   ```
+   name: your-crumb-name
+   type: shell
+   description: Brief description of what this crumb does
+   ```
+3. Add your executable script file (e.g., `your-crumb-name.sh`)
+4. Create a symbolic link in `~/.local/bin` to make it available as a command:
+   ```bash
+   ln -s ~/.ducky/crumbs/your-crumb-name/your-crumb-name.sh ~/.local/bin/your-crumb-name
+   ```
+
+### Polling Mode
+
+Crumbs can be configured for background polling, where the crumb script runs at intervals and the AI analyzes the output.
+
+**Enabling Polling in a Crumb:**
+
+Add polling configuration to your crumb's `info.txt`:
+```
+name: log-crumb
+type: shell
+description: Fetch and analyze server logs
+poll: true
+poll_type: interval          # "interval" (run repeatedly) or "continuous" (run once, tail output)
+poll_interval: 5             # seconds between polls
+poll_prompt: Analyze these logs for errors, warnings, or anomalies. Be concise.
+```
+
+**Polling via CLI:**
+
+```bash
+# Start polling with crumb's default configuration
+ducky --poll log-crumb
+
+# Override interval
+ducky --poll log-crumb --interval 10
+
+# Override prompt
+ducky --poll log-crumb --prompt "Extract only error messages"
+```
+
+**Polling via Interactive Mode:**
+
+```bash
+ducky
+>> /poll log-crumb                    # Use crumb defaults
+>> /poll log-crumb -i 10              # Override interval
+>> /poll log-crumb -p "Summarize"     # Override prompt
+>> /stop-poll                         # Stop polling
+```
+
+**Example Crumb with Polling:**
+
+Directory: `~/.ducky/crumbs/server-logs/`
+
+```
+info.txt:
+  name: server-logs
+  type: shell
+  description: Fetch and analyze server logs
+  poll: true
+  poll_type: interval
+  poll_interval: 5
+  poll_prompt: Analyze these logs for errors, warnings, or anomalies. Be concise.
+
+server-logs.sh:
+  #!/bin/bash
+  curl -s http://localhost:8080/logs | tail -50
+```
+
+**Polling Types:**
+
+- **interval**: Run the crumb script at regular intervals (default)
+- **continuous**: Run the crumb once in the background and stream its output, analyzing periodically
+
+**Stopping Polling:**
+
+Press `Ctrl+C` at any time to stop polling. In interactive mode, you can also use `/stop-poll`.
+
+## Documentation
+
+- **Polling Feature Guide**: See [examples/POLLING_USER_GUIDE.md](examples/POLLING_USER_GUIDE.md) for detailed instructions on creating and using polling crumbs
+- **Mock Log Crumb**: See [examples/mock-logs/](examples/mock-logs/) for an example polling crumb
+
+## Development (uv)
+
+```
+uv sync
+uv run ducky --help
+```
+
+`uv sync` creates a virtual environment and installs dependencies defined in `pyproject.toml` / `uv.lock`.
+
+## Telemetry & Storage
+
+Rubber Ducky stores:
+- `~/.ducky/prompt_history`: readline-compatible history file.
+- `~/.ducky/conversation.log`: JSON lines with timestamps for prompts, assistant messages, and shell executions.
+- `~/.ducky/config`: User preferences including last selected model.
+
+No other telemetry is collected; delete the directory if you want a fresh slate.

rubber_ducky-1.4.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+crumbs/disk-usage/disk-usage.sh,sha256=paiyWTmvzJD2A7wHDU2aIHJVnNqNmBfNV33Os0q7UnQ,451
+crumbs/disk-usage/info.txt,sha256=nKESO2G0biA0fV7peHPk7XaxcJ-wz_RJOkSUXI0VTKA,89
+crumbs/git-log/git-log.sh,sha256=L41W6s-hfJ7FsKgyaS39CRI6tRkgUg-0tHb3Z1FyHqY,595
+crumbs/git-log/info.txt,sha256=G0SDE5nv9mLU5zRpiYLdiR81ox6XRVJhNgnpoFArqeI,92
+crumbs/git-status/git-status.sh,sha256=hXdZxFA8hiJoZ4P8Zv1KPJjwIEpPJG7xibjL2ggbp7o,633
+crumbs/git-status/info.txt,sha256=MgzzfF23muScvS_JihXlpny7unyOCG7hZSAVZf-hQ7c,127
+crumbs/process-list/info.txt,sha256=5KGBQ3zn7hlL3Pv7miAoa3UBLQ-vKD-aLew6h0xeBcQ,88
+crumbs/process-list/process-list.sh,sha256=cwqMqu-xCbCn_DZNCaboZrDwg8A_UOF-bU9D8wxz5X8,744
+crumbs/recent-files/info.txt,sha256=7y9SS_lvYgagaKkVaJp-rF9TEgnUWCe6nj-34FcCvb8,98
+crumbs/recent-files/recent-files.sh,sha256=xpLUYYbouYQzGQZTTVrcybpRYPuoaLdyHny2HoHJZFw,540
+crumbs/system-health/info.txt,sha256=jym4tR5Xy7hEdowlvpufQ4_mA4H88JfQYPGXDZBI9UU,104
+crumbs/system-health/system-health.sh,sha256=NlLK3Th-sJ13Op44fjjEgi7oPscDQUCDBbR1Gd8ghlE,1670
+ducky/__init__.py,sha256=2vLhJxOuJ3lnIeg5rmF6xUvybUT5Qhjej6AS0BeBASY,60
+ducky/config.py,sha256=AH7KMTxPYrtSSmIJ_3qv0WB1tYpAjOWPrvPb7bKQ_cA,2142
+ducky/ducky.py,sha256=qsaGYvw4UQu1NhBkcXkrilSWTrQpp9_Hs22NE0rQR9g,48721
+examples/POLLING_USER_GUIDE.md,sha256=rMEAczZhpgyJ9BgwHkN-SKwSdyas8nlw_CjpV7SFOLA,10685
+examples/mock-logs/info.txt,sha256=apJqEO__UM1R2_2x9MlQOA7XmxvLvbhRvOy-FAwrINo,258
+examples/mock-logs/mock-logs.sh,sha256=zM2JSaCR1eCQLlMvXDWjFnpxZTqrMpnFRa_SgNLPmBk,1132
+rubber_ducky-1.4.0.dist-info/licenses/LICENSE,sha256=gQ1rCmw18NqTk5GxG96F6vgyN70e1c4kcKUtWDwdNaE,1069
+rubber_ducky-1.4.0.dist-info/METADATA,sha256=kJnwYBrQEtk2ugN-7G-bE19vEW7a80XLB3uxqhrqNkc,7859
+rubber_ducky-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rubber_ducky-1.4.0.dist-info/entry_points.txt,sha256=WPnVUUNvWdMDcBlCo8JCzkLghGllMX5QVZyQghyq85Q,75
+rubber_ducky-1.4.0.dist-info/top_level.txt,sha256=cFot69fWrmToFkRuRXwS7_RmtIc9Gjp3RAgrmKkGZoY,22
+rubber_ducky-1.4.0.dist-info/RECORD,,

rubber_ducky-1.4.0.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+crumbs
+ducky
+examples

rubber_ducky-1.3.0.dist-info/METADATA

@@ -1,98 +0,0 @@
-Metadata-Version: 2.4
-Name: rubber-ducky
-Version: 1.3.0
-Summary: Quick CLI do-it-all tool. Use natural language to spit out bash commands
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: colorama>=0.4.6
-Requires-Dist: fastapi>=0.115.11
-Requires-Dist: ollama>=0.6.0
-Requires-Dist: openai>=1.60.2
-Requires-Dist: prompt-toolkit>=3.0.48
-Requires-Dist: rich>=13.9.4
-Requires-Dist: termcolor>=2.5.0
-Dynamic: license-file
-
-# Rubber Ducky
-
-Rubber Ducky is an inline terminal companion that turns natural language prompts into runnable shell commands. Paste multi-line context, get a suggested command, and run it without leaving your terminal.
-
-## Quick Start
-
-| Action | Command |
-| --- | --- |
-| Install globally | `uv tool install rubber-ducky` |
-| Run once | `uvx rubber-ducky -- --help` |
-| Local install | `uv pip install rubber-ducky` |
-
-Requirements:
-- [Ollama](https://ollama.com) running locally
-- Model available via Ollama (default: `qwen3-coder:480b-cloud`, install with `ollama pull qwen3-coder:480b-cloud`)
-
-## Usage
-
-```
-ducky                 # interactive inline session
-ducky --directory src  # preload code from a directory
-ducky --model qwen3 # use a different Ollama model
-```
-
-Both `ducky` and `rubber-ducky` executables map to the same CLI, so `uvx rubber-ducky -- <args>` works as well.
-
-### Inline Session (default)
-
-Launching `ducky` with no arguments opens the inline interface:
-- **Enter** submits; **Ctrl+J** inserts a newline (helpful when crafting multi-line prompts). Hitting **Enter on an empty prompt** reruns the latest suggested command; if none exists yet, it explains the most recent shell output.
-- **Ctrl+R** re-runs the last suggested command.
-- Prefix any line with **`!`** (e.g., `!ls -la`) to run a shell command immediately.
-- Arrow keys browse prompt history, backed by `~/.ducky/prompt_history`.
-- Every prompt, assistant response, and executed command is logged to `~/.ducky/conversation.log`.
-- Press **Ctrl+D** on an empty line to exit.
-- Non-interactive runs such as `cat prompt.txt | ducky` print one response (and suggested command) before exiting; if a TTY is available you'll be asked whether to run the suggested command immediately.
-- If `prompt_toolkit` is unavailable in your environment, Rubber Ducky falls back to a basic input loop (no history or shortcuts); install `prompt-toolkit>=3.0.48` to unlock the richer UI.
-
-`ducky --directory <path>` streams the contents of the provided directory to the assistant the next time you submit a prompt (the directory is read once at startup).
-
-## Crumbs
-
-Crumbs are simple scripts that can be executed within Rubber Ducky. They are stored in `~/.ducky/crumbs/` and can be referenced by name in your prompts.
-
-To use a crumb, simply mention it in your prompt:
-```
-Can you use the uv-server crumb to run the HuggingFace prompt renderer?
-```
-
-### Creating Crumbs
-
-To create a new crumb:
-
-1. Create a new directory in `~/.ducky/crumbs/` with your crumb name
-2. Add an `info.txt` file with metadata:
-   ```
-   name: your-crumb-name
-   type: shell
-   description: Brief description of what this crumb does
-   ```
-3. Add your executable script file (e.g., `your-crumb-name.sh`)
-4. Create a symbolic link in `~/.local/bin` to make it available as a command:
-   ```bash
-   ln -s ~/.ducky/crumbs/your-crumb-name/your-crumb-name.sh ~/.local/bin/your-crumb-name
-   ```
-
-## Development (uv)
-
-```
-uv sync
-uv run ducky --help
-```
-
-`uv sync` creates a virtual environment and installs dependencies defined in `pyproject.toml` / `uv.lock`.
-
-## Telemetry & Storage
-
-Rubber Ducky stores:
-- `~/.ducky/prompt_history`: readline-compatible history file.
-- `~/.ducky/conversation.log`: JSON lines with timestamps for prompts, assistant messages, and shell executions.
-
-No other telemetry is collected; delete the directory if you want a fresh slate.

rubber_ducky-1.3.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-ducky/__init__.py,sha256=2vLhJxOuJ3lnIeg5rmF6xUvybUT5Qhjej6AS0BeBASY,60
-ducky/config.py,sha256=AH7KMTxPYrtSSmIJ_3qv0WB1tYpAjOWPrvPb7bKQ_cA,2142
-ducky/ducky.py,sha256=1B500ievEsIg9mowpzqWuDNGck_DnUM0LdDRDHsm4yo,33716
-rubber_ducky-1.3.0.dist-info/licenses/LICENSE,sha256=gQ1rCmw18NqTk5GxG96F6vgyN70e1c4kcKUtWDwdNaE,1069
-rubber_ducky-1.3.0.dist-info/METADATA,sha256=BVIv6uBWho_khv8AbkQdPMP9PBB6xbvg-U6muGsfdCs,3874
-rubber_ducky-1.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rubber_ducky-1.3.0.dist-info/entry_points.txt,sha256=WPnVUUNvWdMDcBlCo8JCzkLghGllMX5QVZyQghyq85Q,75
-rubber_ducky-1.3.0.dist-info/top_level.txt,sha256=4Q75MONDNPpQ3o17bTu7RFuKwFhTIRzlXP3_LDWQQ30,6
-rubber_ducky-1.3.0.dist-info/RECORD,,

rubber_ducky-1.3.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-ducky