Skip to content

Commit 358a175

Browse files
committed
docs: update provider lists and add Chat Mode documentation
Problem: Documentation was missing new providers (Ollama Cloud, Z.AI) and Chat Mode feature that were added in recent sessions. Solution: - Update provider counts from 10 to 13 across docs - Add Ollama Cloud and Z.AI to all provider lists - Add Ollama Cloud setup section to PROVIDERS.md - Add Chat Mode documentation to FEATURES.md - Add Chat Mode to SANDBOX.md and USER_GUIDE.md Testing: Syntax checks pass on all modified files
1 parent f27c01e commit 358a175

6 files changed

Lines changed: 85 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ CLIO is part of the [Synthetic Autonomic Mind (SAM)](https://github.com/Syntheti
9191
| **Todos** | Manage tasks within your workflow |
9292
| **Web** | Fetch and analyze web content |
9393
| **MCP** | Connect to external tool servers via [Model Context Protocol](docs/MCP.md) |
94-
| **AI Providers** | GitHub Copilot, OpenAI, Google Gemini, DeepSeek, OpenRouter, MiniMax, llama.cpp, LM Studio, SAM |
94+
| **AI Providers** | GitHub Copilot, OpenAI, Google Gemini, DeepSeek, OpenRouter, Ollama Cloud, MiniMax, Z.AI, llama.cpp, LM Studio, SAM |
9595

9696
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
9797

docs/ARCHITECTURE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Quick Overview
88

9-
CLIO is a **terminal-first AI code assistant** built in Perl. It integrates AI models (GitHub Copilot, OpenAI, Google, OpenRouter) with local tools (file operations, git, terminal) to help developers work more effectively.
9+
CLIO is a **terminal-first AI code assistant** built in Perl. It integrates AI models (GitHub Copilot, OpenAI, Google, OpenRouter, Ollama Cloud, MiniMax, Z.AI) with local tools (file operations, git, terminal) to help developers work more effectively.
1010

1111
**Core concept:** User types → CLIO thinks → CLIO uses tools → Results displayed
1212

@@ -97,7 +97,7 @@ Terminal Output
9797
| Logger | `Logger.pm` | Debug and trace output |
9898

9999
**How it works:**
100-
1. APIManager connects to AI provider (GitHub Copilot, OpenAI, Google, OpenRouter)
100+
1. APIManager connects to AI provider (GitHub Copilot, OpenAI, Google, OpenRouter, MiniMax, Z.AI, Ollama Cloud, etc.)
101101
2. WorkflowOrchestrator manages complex interactions, including:
102102
- Proactive context trimming before each API call (keeps messages at ≤75% of context)
103103
- Reactive trimming with 3-attempt escalation when the API rejects due to token overflow
@@ -531,7 +531,7 @@ clio --new # First run
531531

532532
```
533533
lib/CLIO/
534-
Providers.pm # AI provider registry (GitHub Copilot, OpenAI, Google, etc.)
534+
Providers.pm # AI provider registry (GitHub Copilot, OpenAI, Ollama, Z.AI, etc.)
535535
Update.pm # Self-update system
536536
UI/ # Terminal interface
537537
Chat.pm # Main interactive loop

docs/FEATURES.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,24 @@ CLIO uses conservative sampling defaults tuned for reliable tool use. When worki
117117

118118
Overrides are saved globally and visible in `/api show`. Provider-recommended defaults (e.g. MiniMax's `temperature=1.0`) are applied automatically when no override is set - you only need to set these if you want to change from the provider recommendation.
119119

120+
### Chat Mode
121+
122+
For conversational AI without file modifications, use chat mode:
123+
124+
```
125+
clio --chat --new
126+
```
127+
128+
Chat mode:
129+
- Auto-enables sandbox mode for safety
130+
- Restricts tools to: web, file read, memory, interact, todos
131+
- Uses a lighter system prompt optimized for chat
132+
133+
This is useful for:
134+
- Quick questions without modifying code
135+
- Web searches and research
136+
- Explaining concepts or debugging help
137+
120138
### Iteration and Error Recovery
121139

122140
When something goes wrong - a syntax error, a failed test, an unexpected file structure - CLIO doesn't stop. It reads the error, adjusts its approach, and tries again. In interactive mode CLIO has no iteration limit. In non-interactive mode (scripting, sub-agents) a default of 75 iterations applies. Both are configurable.
@@ -241,7 +259,7 @@ Connect to external tool servers via the Model Context Protocol. See [MCP Integr
241259

242260
## 3. AI Providers
243261

244-
CLIO supports 10 AI providers out of the box. Switch between them at any time - even mid-session.
262+
CLIO supports 13 AI providers out of the box. Switch between them at any time - even mid-session.
245263

246264
| Provider | Type | Authentication |
247265
|----------|------|---------------|
@@ -250,7 +268,10 @@ CLIO supports 10 AI providers out of the box. Switch between them at any time -
250268
| **Google Gemini** | Cloud | API key |
251269
| **DeepSeek** | Cloud | API key |
252270
| **OpenRouter** | Cloud | API key |
271+
| **Ollama Cloud** | Cloud | API key |
253272
| **MiniMax** | Cloud | API key (Token Plan support) |
273+
| **Z.AI** | Cloud | API key |
274+
| **Z.AI Coding Plan** | Cloud | API key |
254275
| **llama.cpp** | Local | None |
255276
| **LM Studio** | Local | None |
256277
| **SAM** | Local | API key (optional) |

docs/PROVIDERS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
| **Google Gemini** | `google` | API Key |
1414
| **DeepSeek** | `deepseek` | API Key |
1515
| **OpenRouter** | `openrouter` | API Key |
16+
| **Ollama Cloud** | `ollama_cloud` | API Key |
1617
| **MiniMax** | `minimax` | API Key |
1718
| **MiniMax Token Plan** | `minimax_token` | API Key |
1819
| **Z.AI** | `zai` | API Key |
@@ -187,6 +188,39 @@ Models use the `provider/model` format:
187188

188189
---
189190

191+
### Ollama Cloud
192+
193+
**Best for:** Access to open-source models (Qwen, Gemma, DeepSeek, etc.) with API convenience
194+
195+
**Get API Key:**
196+
1. Create account at [ollama.com](https://ollama.com)
197+
2. Go to your account settings
198+
3. Create an API key
199+
200+
**Configure CLIO:**
201+
```bash
202+
clio --new
203+
/api set provider ollama_cloud
204+
/api set key <your-api-key>
205+
/config save
206+
```
207+
208+
**Available model families:** Qwen, Gemma, DeepSeek, Mistral, Llama, and more. Use `/api models` for the current list.
209+
210+
**Features:**
211+
- Supports tools/function calling
212+
- Streaming responses
213+
- Reasoning models (for thinking-enabled models)
214+
215+
**Example models:**
216+
| Model | Size | Best For |
217+
|-------|------|----------|
218+
| gemma4:31b | 31B | Balanced performance |
219+
| qwen3:8b | 8B | Fast, low memory |
220+
| deepseek-v3.2 | - | Coding, reasoning |
221+
222+
---
223+
190224
### MiniMax
191225

192226
**Best for:** High-throughput coding, large output windows, interleaved reasoning

docs/SANDBOX.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ This handles:
120120

121121
| Scenario | Recommendation |
122122
|----------|----------------|
123+
| Conversational AI, quick questions | `--chat` flag |
123124
| Trusted local environment | No sandbox needed |
124125
| Exploring unfamiliar codebase | `--sandbox` flag |
125126
| Working on sensitive project | `--sandbox` flag |

docs/USER_GUIDE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2001,6 +2001,30 @@ clio --sandbox --new
20012001
- Version control: limited to project repository
20022002
- Terminal operations: NOT restricted
20032003

2004+
### Chat Mode (`--chat` flag)
2005+
2006+
A conversational AI mode optimized for quick questions and web access. Chat mode:
2007+
2008+
- Auto-enables sandbox mode for safety
2009+
- Restricts tools to: web, file read, memory, interact, todos
2010+
- Uses a lighter system prompt optimized for chat
2011+
2012+
```bash
2013+
clio --chat --new
2014+
```
2015+
2016+
**When to use Chat Mode:**
2017+
- Quick questions without modifying code
2018+
- Web searches and research
2019+
- Explaining concepts or code
2020+
- General debugging help
2021+
2022+
**When to use Agent Mode (default):**
2023+
- Making changes to files
2024+
- Running commands
2025+
- Multi-step refactoring
2026+
- Autonomous task completion
2027+
20042028
### Container Sandbox (Docker)
20052029

20062030
For complete isolation, run CLIO in a container:

0 commit comments

Comments
 (0)