tiennm99/ccs
1
0
Fork 0
mirror of https://github.com/tiennm99/ccs.git synced 2026-09-03 12:21:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): update providers, websearch, and add star history

Browse Source 
- Add Copilot to built-in providers table with OAuth auth
- Add "Powered by" section crediting CLIProxyAPI and copilot-api
- Update WebSearch from MCP to CLI tool fallback chain (Gemini/OpenCode/Grok)
- Add centered Star History section before footer
- Remove redundant Project Structure (codebase-summary.md is source of truth)
This commit is contained in:
kaitranntt
2025-12-19 20:18:21 -05:00
parent 1ffd169b98
commit 0dc2da6e5a
1 changed files with 33 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+33 -17
View File
@@ -83,12 +83,17 @@ The dashboard provides visual management for all account types:
| **Claude** | Subscription | `ccs` | Default, strategic planning | | **Claude** | Subscription | `ccs` | Default, strategic planning |
| **Gemini** | OAuth | `ccs gemini` | Zero-config, fast iteration | | **Gemini** | OAuth | `ccs gemini` | Zero-config, fast iteration |
| **Codex** | OAuth | `ccs codex` | Code generation | | **Codex** | OAuth | `ccs codex` | Code generation |
| **Copilot** | OAuth | `ccs copilot` | GitHub Copilot models |
| **Antigravity** | OAuth | `ccs agy` | Alternative routing | | **Antigravity** | OAuth | `ccs agy` | Alternative routing |
| **GLM** | API Key | `ccs glm` | Cost-optimized execution | | **GLM** | API Key | `ccs glm` | Cost-optimized execution |
| **Kimi** | API Key | `ccs kimi` | Long-context, thinking mode | | **Kimi** | API Key | `ccs kimi` | Long-context, thinking mode |
> **OAuth providers** authenticate via browser on first run. Tokens are cached in `~/.ccs/cliproxy/auth/`. > **OAuth providers** authenticate via browser on first run. Tokens are cached in `~/.ccs/cliproxy/auth/`.
**Powered by:**
- [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) - OAuth proxy for Gemini, Codex, Antigravity
- [copilot-api](https://github.com/ericc-ch/copilot-api) - GitHub Copilot API integration
> [!TIP] > [!TIP]
> **Need more?** CCS supports **any Anthropic-compatible API**. Create custom profiles for self-hosted LLMs, enterprise gateways, or alternative providers. See [API Profiles documentation](https://docs.ccs.kaitran.ca/providers/api-profiles). > **Need more?** CCS supports **any Anthropic-compatible API**. Create custom profiles for self-hosted LLMs, enterprise gateways, or alternative providers. See [API Profiles documentation](https://docs.ccs.kaitran.ca/providers/api-profiles).
@@ -197,15 +202,24 @@ Without Developer Mode, CCS falls back to copying directories.
## WebSearch ## WebSearch
Third-party profiles (Gemini, Codex, GLM, etc.) cannot use Anthropic's native WebSearch. CCS automatically configures MCP-based web search as a fallback. Third-party profiles (Gemini, Codex, GLM, etc.) cannot use Anthropic's native WebSearch. CCS automatically provides web search via CLI tools with automatic fallback.
### How It Works ### How It Works
| Profile Type | WebSearch Method | | Profile Type | WebSearch Method |
|--------------|------------------| |--------------|------------------|
| Claude (native) | Anthropic WebSearch API | | Claude (native) | Anthropic WebSearch API |
| OAuth providers | MCP web-search-prime (auto-configured) | | Third-party profiles | CLI Tool Fallback Chain |
| API profiles | MCP web-search-prime (auto-configured) |
### CLI Tool Fallback Chain
CCS intercepts WebSearch requests and routes them through available CLI tools:
| Priority | Tool | Auth | Install |
|----------|------|------|---------|
| 1st | Gemini CLI | OAuth (free) | `npm install -g @google/gemini-cli` |
| 2nd | OpenCode | OAuth (free) | `curl -fsSL https://opencode.ai/install \| bash` |
| 3rd | Grok CLI | API Key | `npm install -g @vibe-kit/grok-cli` |
### Configuration ### Configuration
@@ -213,22 +227,18 @@ Configure via dashboard (**Settings** page) or `~/.ccs/config.yaml`:
```yaml ```yaml
websearch: websearch:
enabled: true # Enable/disable auto-config enabled: true # Enable/disable (default: true)
provider: auto # auto | web-search-prime | brave | tavily gemini:
fallback: true # Enable fallback chain enabled: true # Use Gemini CLI (default: true)
model: gemini-2.5-flash # Model to use
opencode:
enabled: true # Use OpenCode as fallback
grok:
enabled: false # Requires XAI_API_KEY
``` ```
### Optional API Keys > [!TIP]
> **Gemini CLI** is recommended - free OAuth authentication with 1000 requests/day. Just run `gemini` once to authenticate via browser.
For additional search providers, set environment variables:
```bash
export BRAVE_API_KEY="your-key" # Free tier: 15k queries/month
export TAVILY_API_KEY="your-key" # AI-optimized search (paid)
```
> [!NOTE]
> `web-search-prime` works without API keys. Brave/Tavily are optional fallbacks.
See [docs/websearch.md](./docs/websearch.md) for detailed configuration and troubleshooting. See [docs/websearch.md](./docs/websearch.md) for detailed configuration and troubleshooting.
@@ -287,8 +297,14 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md).
MIT License - see [LICENSE](LICENSE). MIT License - see [LICENSE](LICENSE).
<br>
<div align="center"> <div align="center">
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=kaitranntt/ccs&type=date&legend=top-left)](https://www.star-history.com/#kaitranntt/ccs&type=date&legend=top-left)
--- ---
**[ccs.kaitran.ca](https://ccs.kaitran.ca)** | [Report Issues](https://github.com/kaitranntt/ccs/issues) | [Star on GitHub](https://github.com/kaitranntt/ccs) **[ccs.kaitran.ca](https://ccs.kaitran.ca)** | [Report Issues](https://github.com/kaitranntt/ccs/issues) | [Star on GitHub](https://github.com/kaitranntt/ccs)