askii-cli 0.2.5 → 0.2.7

package/README.md

@@ -1,6 +1,6 @@
 # ASKII CLI ( •\_•)>⌐■-■ (⌐■_■)
 
-AI code assistant for your terminal. Powered by Ollama or LM Studio.
+AI code assistant for your terminal. Powered by Ollama, LM Studio, OpenAI, or Anthropic.
 
 ## Install
 
@@ -149,12 +149,52 @@ Without `--yes`, each proposed action is shown with its reasoning and requires `
 
 ---
 
+### `wiki-reload` — Index wiki documentation
+
+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.
+
+**bash**
+
+```bash
+askii wiki-reload --wiki-path ./docs
+askii wiki-reload --wiki-path /home/user/my-project/docs
+```
+
+**PowerShell**
+
+```powershell
+askii wiki-reload --wiki-path .\docs
+askii wiki-reload --wiki-path C:\my-project\docs
+```
+
+After indexing, pass `--wiki-path` and `--use-wiki` to any `ask`, `edit`, or `do` command to inject the top matching documentation chunks as context:
+
+**bash**
+
+```bash
+askii ask --wiki-path ./docs --use-wiki "how do I configure the database?"
+cat src/db.ts | askii edit --wiki-path ./docs --use-wiki "add connection pooling"
+askii do --wiki-path ./docs --use-wiki "implement the auth flow described in the docs"
+```
+
+**PowerShell**
+
+```powershell
+askii ask --wiki-path .\docs --use-wiki "how do I configure the database?"
+Get-Content src\db.ts | askii edit --wiki-path .\docs --use-wiki "add connection pooling"
+askii do --wiki-path .\docs --use-wiki "implement the auth flow described in the docs"
+```
+
+---
+
 ### `browse` — Browser agent
 
 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`).
 
 By default the browser window is **visible**. Pass `--headless` to run in the background.
 
+> **Requires Chrome or Chromium** to be installed. Use `--chrome-path` (or `ASKII_CHROME_PATH`) to specify the executable path if it is not detected automatically.
+
 **bash**
 
 ```bash
@@ -163,6 +203,7 @@ askii browse --yes --ollama-model llava "search Google for Node.js and open the
 askii browse --headless --yes --ollama-model llava "check the title of https://github.com"
 askii browse --max-rounds 10 --ollama-model llava "fill in the login form on example.com"
 askii browse -p lmstudio --lmstudio-model llava-1.5 "go to news.ycombinator.com"
+askii browse --chrome-path "/usr/bin/chromium" --ollama-model llava "go to example.com"
 ```
 
 **PowerShell**
@@ -173,6 +214,7 @@ askii browse --yes --ollama-model llava "search Google for Node.js and open the
 askii browse --headless --yes --ollama-model llava "check the title of https://github.com"
 askii browse --max-rounds 10 --ollama-model llava "fill in the login form on example.com"
 askii browse -p lmstudio --lmstudio-model llava-1.5 "go to news.ycombinator.com"
+askii browse --chrome-path "C:\Program Files\Google\Chrome\Application\chrome.exe" --ollama-model llava "go to example.com"
 ```
 
 Each round the AI can return one of:
@@ -191,19 +233,27 @@ Without `--yes`, each proposed action is shown with its reasoning and requires `
 
 ## Options
 
-| Flag               | Short | Description                                      | Default                  |
-| ------------------ | ----- | ------------------------------------------------ | ------------------------ |
-| `--platform`       | `-p`  | LLM platform: `ollama`, `lmstudio`               | `ollama`                 |
-| `--ollama-url`     |       | Ollama server URL                                | `http://localhost:11434` |
-| `--lmstudio-url`   |       | LM Studio server URL                             | `ws://localhost:1234`    |
-| `--ollama-model`   |       | Ollama model                                     | `gemma3:270m`            |
-| `--lmstudio-model` |       | LM Studio model                                  | `qwen/qwen3-coder-30b`   |
-| `--mode`           |       | Response style: `helpful`, `funny`               | `funny`                  |
-| `--max-rounds`     |       | Max agent rounds for `do` / `control` / `browse` | `5`                      |
-| `--dir`            |       | Working directory for `do`                       | cwd                      |
-| `--code`           | `-c`  | Code input (alternative to stdin)                |                          |
-| `--yes`            | `-y`  | Auto-confirm all actions                         |                          |
-| `--headless`       |       | Run Puppeteer headlessly for `browse`            | `false` (visible)        |
+| Flag                | Short | Description                                               | Default                  |
+| ------------------- | ----- | --------------------------------------------------------- | ------------------------ |
+| `--platform`        | `-p`  | LLM platform: `ollama`, `lmstudio`, `openai`, `anthropic` | `ollama`                 |
+| `--ollama-url`      |       | Ollama server URL                                         | `http://localhost:11434` |
+| `--lmstudio-url`    |       | LM Studio server URL                                      | `ws://localhost:1234`    |
+| `--ollama-model`    |       | Ollama model                                              | `gemma3:270m`            |
+| `--lmstudio-model`  |       | LM Studio model                                           | `qwen/qwen3-coder-30b`   |
+| `--openai-key`      |       | OpenAI API key (env: `ASKII_OPENAI_KEY`)                  |                          |
+| `--openai-model`    |       | OpenAI model                                              | `gpt-4o`                 |
+| `--openai-url`      |       | OpenAI-compatible base URL (env: `ASKII_OPENAI_URL`)      |                          |
+| `--anthropic-key`   |       | Anthropic API key (env: `ASKII_ANTHROPIC_KEY`)            |                          |
+| `--anthropic-model` |       | Anthropic model (env: `ASKII_ANTHROPIC_MODEL`)            | `claude-opus-4-6`        |
+| `--mode`            |       | Response style: `helpful`, `funny`                        | `funny`                  |
+| `--max-rounds`      |       | Max agent rounds for `do` / `control` / `browse`          | `5`                      |
+| `--dir`             |       | Working directory for `do`                                | cwd                      |
+| `--code`            | `-c`  | Code input (alternative to stdin)                         |                          |
+| `--yes`             | `-y`  | Auto-confirm all actions                                  |                          |
+| `--headless`        |       | Run Puppeteer headlessly for `browse`                     | `false` (visible)        |
+| `--chrome-path`     |       | Path to Chrome/Chromium executable for `browse`           |                          |
+| `--wiki-path`       |       | Path to folder with `.md` docs for wiki RAG (env: `ASKII_WIKI_PATH`) | |
+| `--use-wiki`        |       | Inject wiki context into `ask` / `edit` / `do` (env: `ASKII_USE_WIKI=1`) | |
 
 ## Environment Variables
 
@@ -220,9 +270,23 @@ export ASKII_OLLAMA_MODEL=gemma3:270m
 export ASKII_LMSTUDIO_URL=ws://localhost:1234
 export ASKII_LMSTUDIO_MODEL=qwen/qwen3-coder-30b
 
+# OpenAI
+export ASKII_OPENAI_KEY=sk-...
+export ASKII_OPENAI_MODEL=gpt-4o
+export ASKII_OPENAI_URL=   # leave empty for api.openai.com
+
+# Anthropic
+export ASKII_ANTHROPIC_KEY=sk-ant-...
+export ASKII_ANTHROPIC_MODEL=claude-opus-4-6
+
 # Shared
 export ASKII_MODE=funny
 export ASKII_MAX_ROUNDS=5
+export ASKII_CHROME_PATH=/usr/bin/chromium
+
+# Wiki RAG
+export ASKII_WIKI_PATH=./docs
+export ASKII_USE_WIKI=1
 ```
 
 **PowerShell**
@@ -238,9 +302,23 @@ $env:ASKII_OLLAMA_MODEL = "gemma3:270m"
 $env:ASKII_LMSTUDIO_URL = "ws://localhost:1234"
 $env:ASKII_LMSTUDIO_MODEL = "qwen/qwen3-coder-30b"
 
+# OpenAI
+$env:ASKII_OPENAI_KEY = "sk-..."
+$env:ASKII_OPENAI_MODEL = "gpt-4o"
+$env:ASKII_OPENAI_URL = ""   # leave empty for api.openai.com
+
+# Anthropic
+$env:ASKII_ANTHROPIC_KEY = "sk-ant-..."
+$env:ASKII_ANTHROPIC_MODEL = "claude-opus-4-6"
+
 # Shared
 $env:ASKII_MODE = "funny"
 $env:ASKII_MAX_ROUNDS = "5"
+$env:ASKII_CHROME_PATH = "C:\Program Files\Google\Chrome\Application\chrome.exe"
+
+# Wiki RAG
+$env:ASKII_WIKI_PATH = ".\docs"
+$env:ASKII_USE_WIKI = "1"
 ```
 
 ## Platforms
@@ -278,3 +356,41 @@ askii -p lmstudio --lmstudio-model "my-model" ask "explain this function"
 askii -p lmstudio ask "explain this function"
 askii -p lmstudio --lmstudio-model "my-model" ask "explain this function"
 ```
+
+### OpenAI
+
+**bash**
+
+```bash
+askii -p openai --openai-key sk-... ask "what does this do?"
+askii -p openai --openai-key sk-... --openai-model gpt-4-turbo do "add error handling"
+# Azure OpenAI or any compatible API:
+askii -p openai --openai-key sk-... --openai-url https://my-resource.openai.azure.com ask "explain"
+```
+
+**PowerShell**
+
+```powershell
+askii -p openai --openai-key sk-... ask "what does this do?"
+askii -p openai --openai-key sk-... --openai-model gpt-4-turbo do "add error handling"
+# Azure OpenAI or any compatible API:
+askii -p openai --openai-key sk-... --openai-url https://my-resource.openai.azure.com ask "explain"
+```
+
+### Anthropic
+
+**bash**
+
+```bash
+askii -p anthropic --anthropic-key sk-ant-... ask "what does this do?"
+askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-sonnet-4-6 do "add error handling"
+askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-haiku-4-5 explain "arr.reduce((a, b) => a + b, 0)"
+```
+
+**PowerShell**
+
+```powershell
+askii -p anthropic --anthropic-key sk-ant-... ask "what does this do?"
+askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-sonnet-4-6 do "add error handling"
+askii -p anthropic --anthropic-key sk-ant-... --anthropic-model claude-haiku-4-5 explain "arr.reduce((a, b) => a + b, 0)"
+```