askii-cli 0.2.6 → 0.2.8
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 +94 -18
- package/dist/index.js +401 -339
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ASKII CLI ( •\_•)>⌐■-■ (⌐■_■)
|
|
2
2
|
|
|
3
|
-
AI code assistant for your terminal. Powered by Ollama, LM Studio, or
|
|
3
|
+
AI code assistant for your terminal. Powered by Ollama, LM Studio, OpenAI, or Anthropic.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -149,6 +149,44 @@ Without `--yes`, each proposed action is shown with its reasoning and requires `
|
|
|
149
149
|
|
|
150
150
|
---
|
|
151
151
|
|
|
152
|
+
### `wiki-reload` — Index wiki documentation
|
|
153
|
+
|
|
154
|
+
Walks all `.md` files under `--wiki-path`, splits them into sections by heading, builds a [MiniSearch](https://github.com/lucaong/minisearch) BM25 index, and saves it as `.askii-wiki-index.json` inside the wiki folder. Run this once after pointing `--wiki-path` at your docs, and again whenever the docs change.
|
|
155
|
+
|
|
156
|
+
**bash**
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
askii wiki-reload --wiki-path ./docs
|
|
160
|
+
askii wiki-reload --wiki-path /home/user/my-project/docs
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
**PowerShell**
|
|
164
|
+
|
|
165
|
+
```powershell
|
|
166
|
+
askii wiki-reload --wiki-path .\docs
|
|
167
|
+
askii wiki-reload --wiki-path C:\my-project\docs
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
After indexing, pass `--wiki-path` and `--use-wiki` to any `ask`, `edit`, or `do` command to inject the top matching documentation chunks as context:
|
|
171
|
+
|
|
172
|
+
**bash**
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
askii ask --wiki-path ./docs --use-wiki "how do I configure the database?"
|
|
176
|
+
cat src/db.ts | askii edit --wiki-path ./docs --use-wiki "add connection pooling"
|
|
177
|
+
askii do --wiki-path ./docs --use-wiki "implement the auth flow described in the docs"
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
**PowerShell**
|
|
181
|
+
|
|
182
|
+
```powershell
|
|
183
|
+
askii ask --wiki-path .\docs --use-wiki "how do I configure the database?"
|
|
184
|
+
Get-Content src\db.ts | askii edit --wiki-path .\docs --use-wiki "add connection pooling"
|
|
185
|
+
askii do --wiki-path .\docs --use-wiki "implement the auth flow described in the docs"
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
152
190
|
### `browse` — Browser agent
|
|
153
191
|
|
|
154
192
|
Launches a Puppeteer browser, takes a screenshot of the current page and its URL, sends both to the AI, and executes the returned action. Repeats until the AI returns `DONE` or `--max-rounds` is reached. Requires a **vision-capable model** (e.g. `llava`, `moondream2`).
|
|
@@ -195,23 +233,27 @@ Without `--yes`, each proposed action is shown with its reasoning and requires `
|
|
|
195
233
|
|
|
196
234
|
## Options
|
|
197
235
|
|
|
198
|
-
| Flag
|
|
199
|
-
|
|
|
200
|
-
| `--platform`
|
|
201
|
-
| `--ollama-url`
|
|
202
|
-
| `--lmstudio-url`
|
|
203
|
-
| `--ollama-model`
|
|
204
|
-
| `--lmstudio-model`
|
|
205
|
-
| `--openai-key`
|
|
206
|
-
| `--openai-model`
|
|
207
|
-
| `--openai-url`
|
|
208
|
-
| `--
|
|
209
|
-
| `--
|
|
210
|
-
| `--
|
|
211
|
-
| `--
|
|
212
|
-
| `--
|
|
213
|
-
| `--
|
|
214
|
-
| `--
|
|
236
|
+
| Flag | Short | Description | Default |
|
|
237
|
+
| ------------------- | ----- | --------------------------------------------------------- | ------------------------ |
|
|
238
|
+
| `--platform` | `-p` | LLM platform: `ollama`, `lmstudio`, `openai`, `anthropic` | `ollama` |
|
|
239
|
+
| `--ollama-url` | | Ollama server URL | `http://localhost:11434` |
|
|
240
|
+
| `--lmstudio-url` | | LM Studio server URL | `ws://localhost:1234` |
|
|
241
|
+
| `--ollama-model` | | Ollama model | `gemma3:270m` |
|
|
242
|
+
| `--lmstudio-model` | | LM Studio model | `qwen/qwen3-coder-30b` |
|
|
243
|
+
| `--openai-key` | | OpenAI API key (env: `ASKII_OPENAI_KEY`) | |
|
|
244
|
+
| `--openai-model` | | OpenAI model | `gpt-4o` |
|
|
245
|
+
| `--openai-url` | | OpenAI-compatible base URL (env: `ASKII_OPENAI_URL`) | |
|
|
246
|
+
| `--anthropic-key` | | Anthropic API key (env: `ASKII_ANTHROPIC_KEY`) | |
|
|
247
|
+
| `--anthropic-model` | | Anthropic model (env: `ASKII_ANTHROPIC_MODEL`) | `claude-opus-4-6` |
|
|
248
|
+
| `--mode` | | Response style: `helpful`, `funny` | `funny` |
|
|
249
|
+
| `--max-rounds` | | Max agent rounds for `do` / `control` / `browse` | `5` |
|
|
250
|
+
| `--dir` | | Working directory for `do` | cwd |
|
|
251
|
+
| `--code` | `-c` | Code input (alternative to stdin) | |
|
|
252
|
+
| `--yes` | `-y` | Auto-confirm all actions | |
|
|
253
|
+
| `--headless` | | Run Puppeteer headlessly for `browse` | `false` (visible) |
|
|
254
|
+
| `--chrome-path` | | Path to Chrome/Chromium executable for `browse` | |
|
|
255
|
+
| `--wiki-path` | | Path to folder with `.md` docs for wiki RAG (env: `ASKII_WIKI_PATH`) | |
|
|
256
|
+
| `--use-wiki` | | Inject wiki context into `ask` / `edit` / `do` (env: `ASKII_USE_WIKI=1`) | |
|
|
215
257
|
|
|
216
258
|
## Environment Variables
|
|
217
259
|
|
|
@@ -233,10 +275,18 @@ export ASKII_OPENAI_KEY=sk-...
|
|
|
233
275
|
export ASKII_OPENAI_MODEL=gpt-4o
|
|
234
276
|
export ASKII_OPENAI_URL= # leave empty for api.openai.com
|
|
235
277
|
|
|
278
|
+
# Anthropic
|
|
279
|
+
export ASKII_ANTHROPIC_KEY=sk-ant-...
|
|
280
|
+
export ASKII_ANTHROPIC_MODEL=claude-opus-4-6
|
|
281
|
+
|
|
236
282
|
# Shared
|
|
237
283
|
export ASKII_MODE=funny
|
|
238
284
|
export ASKII_MAX_ROUNDS=5
|
|
239
285
|
export ASKII_CHROME_PATH=/usr/bin/chromium
|
|
286
|
+
|
|
287
|
+
# Wiki RAG
|
|
288
|
+
export ASKII_WIKI_PATH=./docs
|
|
289
|
+
export ASKII_USE_WIKI=1
|
|
240
290
|
```
|
|
241
291
|
|
|
242
292
|
**PowerShell**
|
|
@@ -257,10 +307,18 @@ $env:ASKII_OPENAI_KEY = "sk-..."
|
|
|
257
307
|
$env:ASKII_OPENAI_MODEL = "gpt-4o"
|
|
258
308
|
$env:ASKII_OPENAI_URL = "" # leave empty for api.openai.com
|
|
259
309
|
|
|
310
|
+
# Anthropic
|
|
311
|
+
$env:ASKII_ANTHROPIC_KEY = "sk-ant-..."
|
|
312
|
+
$env:ASKII_ANTHROPIC_MODEL = "claude-opus-4-6"
|
|
313
|
+
|
|
260
314
|
# Shared
|
|
261
315
|
$env:ASKII_MODE = "funny"
|
|
262
316
|
$env:ASKII_MAX_ROUNDS = "5"
|
|
263
317
|
$env:ASKII_CHROME_PATH = "C:\Program Files\Google\Chrome\Application\chrome.exe"
|
|
318
|
+
|
|
319
|
+
# Wiki RAG
|
|
320
|
+
$env:ASKII_WIKI_PATH = ".\docs"
|
|
321
|
+
$env:ASKII_USE_WIKI = "1"
|
|
264
322
|
```
|
|
265
323
|
|
|
266
324
|
## Platforms
|
|
@@ -318,3 +376,21 @@ askii -p openai --openai-key sk-... --openai-model gpt-4-turbo do "add error han
|
|
|
318
376
|
# Azure OpenAI or any compatible API:
|
|
319
377
|
askii -p openai --openai-key sk-... --openai-url https://my-resource.openai.azure.com ask "explain"
|
|
320
378
|
```
|
|
379
|
+
|
|
380
|
+
### Anthropic
|
|
381
|
+
|
|
382
|
+
**bash**
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
askii -p anthropic --anthropic-key sk-ant-... ask "what does this do?"
|
|
386
|
+
askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-sonnet-4-6 do "add error handling"
|
|
387
|
+
askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-haiku-4-5 explain "arr.reduce((a, b) => a + b, 0)"
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
**PowerShell**
|
|
391
|
+
|
|
392
|
+
```powershell
|
|
393
|
+
askii -p anthropic --anthropic-key sk-ant-... ask "what does this do?"
|
|
394
|
+
askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-sonnet-4-6 do "add error handling"
|
|
395
|
+
askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-haiku-4-5 explain "arr.reduce((a, b) => a + b, 0)"
|
|
396
|
+
```
|