@k-leumas/queque-cli 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -12
- package/dist/cli/app.js +1917 -262
- package/dist/cli/app.js.map +1 -1
- package/package.json +4 -1
- package/shell/zsh/queque.zsh +28 -1
package/README.md
CHANGED
|
@@ -68,7 +68,7 @@ An empty or whitespace-only value counts as unset.
|
|
|
68
68
|
|
|
69
69
|
**Which route wins.** A non-empty `ANTHROPIC_API_KEY` always wins: QueQue calls Claude through the Anthropic SDK and never runs `claude -p`. There is no automatic fallback in either direction. If the API-key request fails, QueQue shows that error instead of trying your Claude Code login, and a failed `claude -p` run never falls back to a key. To switch to your Claude Code login, remove the key from your environment and `~/.env.local`, then restart the daemon.
|
|
70
70
|
|
|
71
|
-
`QQ_MODEL` picks the model on the API-key route only. The default is `claude-sonnet-5`.
|
|
71
|
+
`QQ_MODEL` (in your environment or `~/.env.local`) picks the model on the API-key route only. The default is `claude-sonnet-5`.
|
|
72
72
|
|
|
73
73
|
### OpenAI or Ollama (beta)
|
|
74
74
|
|
|
@@ -85,6 +85,8 @@ It asks one question (Claude, OpenAI or Ollama), saves your answer to `~/.config
|
|
|
85
85
|
|
|
86
86
|
Your choice sticks. If the chosen provider fails, `??` shows that provider's error; QueQue never switches to a different provider on its own. Run `qq init provider` again to switch, including back to Claude.
|
|
87
87
|
|
|
88
|
+
Every provider gets 25 seconds per `??`. If an OpenAI or Ollama answer is cut off before a full command, QueQue asks the same provider once more within those same 25 seconds. If the second try also falls short, you get the commands that did arrive, or a "cut off" message when none did. When an OpenAI model rejects one of QueQue's request settings, QueQue re-sends without it and remembers that for the model until the daemon restarts.
|
|
89
|
+
|
|
88
90
|
`provider.json` is plain JSON you can edit by hand, and QueQue reads it again on every `??`:
|
|
89
91
|
|
|
90
92
|
```json
|
|
@@ -95,7 +97,7 @@ Add `"model"` to an OpenAI pin to change the model, or `"baseUrl"` to an Ollama
|
|
|
95
97
|
|
|
96
98
|
### After changing your key or settings
|
|
97
99
|
|
|
98
|
-
A background daemon answers `??` for every terminal. It starts with your first interactive shell (and again on the next `??` if it is not running) and inherits that shell's environment. It reads `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, `QQ_MODEL`, `~/.env.local` and `~/.config/qq/config.json` once, when it starts. `provider.json` is the exception: it is read on every `??`.
|
|
100
|
+
A background daemon answers `??` for every terminal. It starts with your first interactive shell (and again on the next `??` if it is not running) and inherits that shell's environment. It reads `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, `QQ_MODEL`, `~/.env.local` and `~/.config/qq/config.json` once, when it starts. `provider.json` is the exception: it is read on every `??`. On the Claude Code login route, the daemon also keeps one idle `claude -p` process ready, so the next `??` skips Claude Code's start-up.
|
|
99
101
|
|
|
100
102
|
- `qq init provider` restarts the daemon for you, so running it after exporting a new key is enough.
|
|
101
103
|
|
|
@@ -125,9 +127,13 @@ A command that matches a destructive pattern (`rm`, `sudo` and similar) is marke
|
|
|
125
127
|
|
|
126
128
|
### Installed-tool awareness
|
|
127
129
|
|
|
128
|
-
|
|
130
|
+
On every `??`, zsh refreshes its list of the commands it can find (`rehash`), so a tool you installed a moment ago in the same shell counts. QueQue uses that list in two ways.
|
|
131
|
+
|
|
132
|
+
**It tells the provider which well-known tools you have.** QueQue ships a fixed catalog of 196 public command-line tool names that have common alternatives, such as `rg`, `fd`, `bat`, `jq` and `kubectl`. The request includes only the catalog tools you have installed, with instructions to prefer them, to make at least one suggestion that uses only installed tools, and never to suggest install steps. The catalog mostly leaves out basic utilities such as `ls`, `grep` and `find`; the provider is told those are present. Nothing outside the catalog is sent: the rest of your `PATH`, your shell functions and your aliases stay on your machine. The catalog is checked twice, once before the request leaves the client and again just before the prompt is built, so a name that is not in it never reaches a provider.
|
|
133
|
+
|
|
134
|
+
**It marks suggestions that need a missing tool.** This check runs locally, against the full list. A row that needs a tool zsh cannot find gets `ⓘ` before its explanation, and the legend reads `ⓘ not installed`. The row stays selectable. When QueQue knows how to install that tool with brew, apt, dnf or pacman, the legend adds `tab prepends the install command`: press `Tab` (or `Shift+Tab`) on the row to switch it to the install form, and again to switch back. The install form is inserted like any other command, never run.
|
|
129
135
|
|
|
130
|
-
Set `QQ_TOOL_AWARENESS=0` in your shell to turn
|
|
136
|
+
Set `QQ_TOOL_AWARENESS=0` in your shell to turn off both: no tool names are sent and no rows are marked.
|
|
131
137
|
|
|
132
138
|
### Inside Zellij
|
|
133
139
|
|
|
@@ -145,20 +151,20 @@ QueQue is **insertion-only**: it writes commands into your shell buffer — you
|
|
|
145
151
|
|
|
146
152
|
- Your query text and current working directory
|
|
147
153
|
- Your OS platform name (for example `darwin` or `linux`) and shell name (`zsh`)
|
|
148
|
-
- Git metadata (branch, dirty flag, changed file *names* — not file contents)
|
|
154
|
+
- Git metadata (repository root path, branch, dirty flag, changed file *names* — not file contents)
|
|
149
155
|
- Parsed filename hints from your query (no disk reads)
|
|
150
|
-
- The names of installed tools that appear in QueQue's public tool
|
|
156
|
+
- The names of installed tools that appear in QueQue's public catalog of 196 well-known tools (see [Installed-tool awareness](#installed-tool-awareness)). The rest of your `PATH`, your function names and your alias names stay on your machine. `QQ_TOOL_AWARENESS=0` stops even the catalog names.
|
|
151
157
|
|
|
152
158
|
**With Ollama**, the same context goes only to your Ollama server (`http://localhost:11434` by default, or the `baseUrl` in `provider.json`). With the default setting, nothing leaves your machine. A `baseUrl` that starts with `http://` and names another machine sends that context across the network unencrypted; for a remote server, use an `https://` URL (for example behind a reverse proxy).
|
|
153
159
|
|
|
154
160
|
**What QueQue never sends:**
|
|
155
161
|
|
|
156
|
-
- File contents
|
|
157
|
-
- Paths matching sensitive patterns (`.env`, credentials, `.pem`, `id_rsa`,
|
|
162
|
+
- File contents. `QQ_ALLOW_FILE_READ=1` is reserved for a future opt-in and reads nothing today.
|
|
163
|
+
- Paths matching sensitive patterns (`.env`, credentials, `.pem`, `id_rsa`, `.ssh/`, `.aws/`, `secret`) are stripped from git context
|
|
158
164
|
|
|
159
165
|
**Debug logging:** The client and daemon append short diagnostics to `/tmp/qq-<uid>-debug.log`, or to the file named by `QQ_DEBUG_LOG_FILE`. Shell buffer and query text are redacted unless `QQ_DEBUG_VERBOSE=1`. The zsh widget adds its own lines only when `QQ_DEBUG_LOG_FILE` is set. The log stays on your machine.
|
|
160
166
|
|
|
161
|
-
**User config:** Copy [docs/config.example.json](docs/config.example.json) to `~/.config/qq/config.json` to add extra sensitive path patterns, log redaction keys, or destructive-command warnings. Built-in defaults always apply — your patterns are merged on top. Override the file path with `QQ_CONFIG_FILE
|
|
167
|
+
**User config:** Copy [docs/config.example.json](docs/config.example.json) to `~/.config/qq/config.json` to add extra sensitive path patterns, log redaction keys, or destructive-command warnings. Built-in defaults always apply — your patterns are merged on top. Override the file path with `QQ_CONFIG_FILE`: a leading `~/` means your home directory, and a relative path is resolved against your home directory. Malformed `config.json` is ignored with a warning; QueQue falls back to built-in defaults (fail-closed).
|
|
162
168
|
|
|
163
169
|
See [docs/EXTENSIONS.md](docs/EXTENSIONS.md) for the expansion path (local learning, multi-provider, plugins).
|
|
164
170
|
|
|
@@ -168,12 +174,12 @@ Copy [docs/config.example.json](docs/config.example.json) to `~/.config/qq/confi
|
|
|
168
174
|
|
|
169
175
|
| Field | Type | Purpose |
|
|
170
176
|
|-------|------|---------|
|
|
171
|
-
| `effort` | `"low" \| "medium" \| "high" \| "xhigh" \| "max"` | Claude effort for `claude -p` (`--effort`) and for the API-key SDK path, which sends it as `output_config.effort`. The SDK path omits it when `QQ_MODEL` names a model without effort support (Haiku 4.5, Sonnet 4.5 or older); a level that a `QQ_MODEL` model does not support (for example `xhigh` on Opus 4.5) is your responsibility. Default `low`. Trimmed and case-insensitive; invalid values fall back to `low` without affecting the rest of the file. Takes effect after a [daemon restart](#after-changing-your-key-or-settings), because the daemon reads config.json once. |
|
|
172
|
-
| `privacy.sensitivePathPatterns` | `string[]` | Extra regex patterns merged onto built-in defaults (`.env`, credentials, keys, etc.). Built-in patterns are never removed. |
|
|
177
|
+
| `effort` | `"low" \| "medium" \| "high" \| "xhigh" \| "max"` | Claude effort for `claude -p` (`--effort`) and for the API-key SDK path, which sends it as `output_config.effort`. The SDK path omits it when `QQ_MODEL` names a model without effort support (Haiku 4.5, Sonnet 4.5 or older); a level that a `QQ_MODEL` model does not support (for example `xhigh` on Opus 4.5) is your responsibility. Default `low`. Trimmed and case-insensitive; invalid values fall back to `low` without affecting the rest of the file. Takes effect after a [daemon restart](#after-changing-your-key-or-settings), because the daemon reads config.json once. OpenAI and Ollama ignore it. |
|
|
178
|
+
| `privacy.sensitivePathPatterns` | `string[]` | Extra regex patterns merged onto built-in defaults (`.env`, credentials, keys, etc.). Built-in patterns are never removed. An invalid pattern, or one longer than 256 characters, is skipped. |
|
|
173
179
|
| `privacy.redactLogKeys` | `string[]` | Extra JSON keys to redact in debug logs (merged with defaults: `lbuffer`, `rbuffer`, `queryText`, `request`). |
|
|
174
180
|
| `privacy.allowFileRead` | `boolean` | Opt-in gate for future file-content context. Env `QQ_ALLOW_FILE_READ=1` overrides this. No file reads in v1. |
|
|
175
181
|
| `privacy.useGitignore` | `boolean` | Reserved for future gitignore-based filtering. Ignored today. |
|
|
176
|
-
| `safety.destructiveCommandPatterns` | `string[]` | Extra warn-only UI patterns merged onto built-in defaults (`rm`, `sudo`,
|
|
182
|
+
| `safety.destructiveCommandPatterns` | `string[]` | Extra warn-only UI patterns merged onto built-in defaults (`rm`, `sudo`, `chmod -R`, writes to `/dev/`, `curl` or `wget` piped to `sh`). The same skip rule applies. |
|
|
177
183
|
|
|
178
184
|
See [docs/SYSTEM_DESIGN.md](docs/SYSTEM_DESIGN.md) for architecture.
|
|
179
185
|
|