askii-cli 0.2.5 → 0.2.6

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.
Files changed (3) hide show
  1. package/README.md +54 -14
  2. package/dist/index.js +778 -298
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # ASKII CLI ( •\_•)>⌐■-■ (⌐■_■)
2
2
 
3
- AI code assistant for your terminal. Powered by Ollama or LM Studio.
3
+ AI code assistant for your terminal. Powered by Ollama, LM Studio, or OpenAI.
4
4
 
5
5
  ## Install
6
6
 
@@ -155,6 +155,8 @@ Launches a Puppeteer browser, takes a screenshot of the current page and its URL
155
155
 
156
156
  By default the browser window is **visible**. Pass `--headless` to run in the background.
157
157
 
158
+ > **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.
159
+
158
160
  **bash**
159
161
 
160
162
  ```bash
@@ -163,6 +165,7 @@ askii browse --yes --ollama-model llava "search Google for Node.js and open the
163
165
  askii browse --headless --yes --ollama-model llava "check the title of https://github.com"
164
166
  askii browse --max-rounds 10 --ollama-model llava "fill in the login form on example.com"
165
167
  askii browse -p lmstudio --lmstudio-model llava-1.5 "go to news.ycombinator.com"
168
+ askii browse --chrome-path "/usr/bin/chromium" --ollama-model llava "go to example.com"
166
169
  ```
167
170
 
168
171
  **PowerShell**
@@ -173,6 +176,7 @@ askii browse --yes --ollama-model llava "search Google for Node.js and open the
173
176
  askii browse --headless --yes --ollama-model llava "check the title of https://github.com"
174
177
  askii browse --max-rounds 10 --ollama-model llava "fill in the login form on example.com"
175
178
  askii browse -p lmstudio --lmstudio-model llava-1.5 "go to news.ycombinator.com"
179
+ askii browse --chrome-path "C:\Program Files\Google\Chrome\Application\chrome.exe" --ollama-model llava "go to example.com"
176
180
  ```
177
181
 
178
182
  Each round the AI can return one of:
@@ -191,19 +195,23 @@ Without `--yes`, each proposed action is shown with its reasoning and requires `
191
195
 
192
196
  ## Options
193
197
 
194
- | Flag | Short | Description | Default |
195
- | ------------------ | ----- | ------------------------------------------------ | ------------------------ |
196
- | `--platform` | `-p` | LLM platform: `ollama`, `lmstudio` | `ollama` |
197
- | `--ollama-url` | | Ollama server URL | `http://localhost:11434` |
198
- | `--lmstudio-url` | | LM Studio server URL | `ws://localhost:1234` |
199
- | `--ollama-model` | | Ollama model | `gemma3:270m` |
200
- | `--lmstudio-model` | | LM Studio model | `qwen/qwen3-coder-30b` |
201
- | `--mode` | | Response style: `helpful`, `funny` | `funny` |
202
- | `--max-rounds` | | Max agent rounds for `do` / `control` / `browse` | `5` |
203
- | `--dir` | | Working directory for `do` | cwd |
204
- | `--code` | `-c` | Code input (alternative to stdin) | |
205
- | `--yes` | `-y` | Auto-confirm all actions | |
206
- | `--headless` | | Run Puppeteer headlessly for `browse` | `false` (visible) |
198
+ | Flag | Short | Description | Default |
199
+ | ------------------ | ----- | ---------------------------------------------------- | ------------------------ |
200
+ | `--platform` | `-p` | LLM platform: `ollama`, `lmstudio`, `openai` | `ollama` |
201
+ | `--ollama-url` | | Ollama server URL | `http://localhost:11434` |
202
+ | `--lmstudio-url` | | LM Studio server URL | `ws://localhost:1234` |
203
+ | `--ollama-model` | | Ollama model | `gemma3:270m` |
204
+ | `--lmstudio-model` | | LM Studio model | `qwen/qwen3-coder-30b` |
205
+ | `--openai-key` | | OpenAI API key (env: `ASKII_OPENAI_KEY`) | |
206
+ | `--openai-model` | | OpenAI model | `gpt-4o` |
207
+ | `--openai-url` | | OpenAI-compatible base URL (env: `ASKII_OPENAI_URL`) | |
208
+ | `--mode` | | Response style: `helpful`, `funny` | `funny` |
209
+ | `--max-rounds` | | Max agent rounds for `do` / `control` / `browse` | `5` |
210
+ | `--dir` | | Working directory for `do` | cwd |
211
+ | `--code` | `-c` | Code input (alternative to stdin) | |
212
+ | `--yes` | `-y` | Auto-confirm all actions | |
213
+ | `--headless` | | Run Puppeteer headlessly for `browse` | `false` (visible) |
214
+ | `--chrome-path` | | Path to Chrome/Chromium executable for `browse` | |
207
215
 
208
216
  ## Environment Variables
209
217
 
@@ -220,9 +228,15 @@ export ASKII_OLLAMA_MODEL=gemma3:270m
220
228
  export ASKII_LMSTUDIO_URL=ws://localhost:1234
221
229
  export ASKII_LMSTUDIO_MODEL=qwen/qwen3-coder-30b
222
230
 
231
+ # OpenAI
232
+ export ASKII_OPENAI_KEY=sk-...
233
+ export ASKII_OPENAI_MODEL=gpt-4o
234
+ export ASKII_OPENAI_URL= # leave empty for api.openai.com
235
+
223
236
  # Shared
224
237
  export ASKII_MODE=funny
225
238
  export ASKII_MAX_ROUNDS=5
239
+ export ASKII_CHROME_PATH=/usr/bin/chromium
226
240
  ```
227
241
 
228
242
  **PowerShell**
@@ -238,9 +252,15 @@ $env:ASKII_OLLAMA_MODEL = "gemma3:270m"
238
252
  $env:ASKII_LMSTUDIO_URL = "ws://localhost:1234"
239
253
  $env:ASKII_LMSTUDIO_MODEL = "qwen/qwen3-coder-30b"
240
254
 
255
+ # OpenAI
256
+ $env:ASKII_OPENAI_KEY = "sk-..."
257
+ $env:ASKII_OPENAI_MODEL = "gpt-4o"
258
+ $env:ASKII_OPENAI_URL = "" # leave empty for api.openai.com
259
+
241
260
  # Shared
242
261
  $env:ASKII_MODE = "funny"
243
262
  $env:ASKII_MAX_ROUNDS = "5"
263
+ $env:ASKII_CHROME_PATH = "C:\Program Files\Google\Chrome\Application\chrome.exe"
244
264
  ```
245
265
 
246
266
  ## Platforms
@@ -278,3 +298,23 @@ askii -p lmstudio --lmstudio-model "my-model" ask "explain this function"
278
298
  askii -p lmstudio ask "explain this function"
279
299
  askii -p lmstudio --lmstudio-model "my-model" ask "explain this function"
280
300
  ```
301
+
302
+ ### OpenAI
303
+
304
+ **bash**
305
+
306
+ ```bash
307
+ askii -p openai --openai-key sk-... ask "what does this do?"
308
+ askii -p openai --openai-key sk-... --openai-model gpt-4-turbo do "add error handling"
309
+ # Azure OpenAI or any compatible API:
310
+ askii -p openai --openai-key sk-... --openai-url https://my-resource.openai.azure.com ask "explain"
311
+ ```
312
+
313
+ **PowerShell**
314
+
315
+ ```powershell
316
+ askii -p openai --openai-key sk-... ask "what does this do?"
317
+ askii -p openai --openai-key sk-... --openai-model gpt-4-turbo do "add error handling"
318
+ # Azure OpenAI or any compatible API:
319
+ askii -p openai --openai-key sk-... --openai-url https://my-resource.openai.azure.com ask "explain"
320
+ ```