@k-leumas/queque-cli 0.3.9 → 0.4.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 +38 -0
- package/dist/cli/main.js +699 -286
- package/dist/cli/main.js.map +1 -1
- package/package.json +2 -6
- package/shell/zsh/queque.zsh +8 -1
package/README.md
CHANGED
|
@@ -66,5 +66,43 @@ Press `Esc` to cancel and return to what you were typing, you can even tweak you
|
|
|
66
66
|
|
|
67
67
|
QueQue detects Zellij automatically and opens in a floating pane instead of inline. Same trigger, same result, better layout.
|
|
68
68
|
|
|
69
|
+
Set `QQ_PANE_WIDTH` (default `80`) and `QQ_PANE_HEIGHT` (default `24`) to resize the floating pane.
|
|
70
|
+
|
|
71
|
+
Without Zellij, QueQue falls back to an inline TUI in your current terminal session.
|
|
72
|
+
|
|
73
|
+
## Privacy defaults
|
|
74
|
+
|
|
75
|
+
QueQue is **insertion-only**: it writes commands into your shell buffer — you press Enter to run them. QueQue never auto-executes suggestions.
|
|
76
|
+
|
|
77
|
+
**What leaves your machine (when using Claude):**
|
|
78
|
+
|
|
79
|
+
- Your query text and current working directory
|
|
80
|
+
- Git metadata (branch, dirty flag, changed file *names* — not file contents)
|
|
81
|
+
- Parsed filename hints from your query (no disk reads)
|
|
82
|
+
|
|
83
|
+
**What QueQue never sends:**
|
|
84
|
+
|
|
85
|
+
- File contents (unless you explicitly opt in later with `QQ_ALLOW_FILE_READ=1`)
|
|
86
|
+
- Paths matching sensitive patterns (`.env`, credentials, `.pem`, `id_rsa`, etc.) are stripped from git context
|
|
87
|
+
|
|
88
|
+
**Debug logging:** Off by default. When enabled, logs redact shell buffer text unless `QQ_DEBUG_VERBOSE=1`.
|
|
89
|
+
|
|
90
|
+
**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`. Malformed `config.json` is ignored with a warning; QueQue falls back to built-in defaults (fail-closed).
|
|
91
|
+
|
|
92
|
+
See [docs/EXTENSIONS.md](docs/EXTENSIONS.md) for the expansion path (local learning, multi-provider, plugins).
|
|
93
|
+
|
|
94
|
+
## Configuration reference
|
|
95
|
+
|
|
96
|
+
Copy [docs/config.example.json](docs/config.example.json) to `~/.config/qq/config.json` (or set `QQ_CONFIG_FILE`). Field meanings:
|
|
97
|
+
|
|
98
|
+
| Field | Type | Purpose |
|
|
99
|
+
|-------|------|---------|
|
|
100
|
+
| `privacy.sensitivePathPatterns` | `string[]` | Extra regex patterns merged onto built-in defaults (`.env`, credentials, keys, etc.). Built-in patterns are never removed. |
|
|
101
|
+
| `privacy.redactLogKeys` | `string[]` | Extra JSON keys to redact in debug logs (merged with defaults: `lbuffer`, `rbuffer`, `queryText`, `request`). |
|
|
102
|
+
| `privacy.allowFileRead` | `boolean` | Opt-in gate for future file-content context. Env `QQ_ALLOW_FILE_READ=1` overrides this. No file reads in v1. |
|
|
103
|
+
| `privacy.useGitignore` | `boolean` | Reserved for future gitignore-based filtering. Ignored today. |
|
|
104
|
+
| `safety.destructiveCommandPatterns` | `string[]` | Extra warn-only UI patterns merged onto built-in defaults (`rm`, `sudo`, etc.). |
|
|
105
|
+
|
|
106
|
+
See [docs/SYSTEM_DESIGN.md](docs/SYSTEM_DESIGN.md) for architecture and [docs/EXTENSIONS.md](docs/EXTENSIONS.md) for Phase 7/8 expansion.
|
|
69
107
|
|
|
70
108
|
|