Skip to content

README.md

Latest commit

 

History

History
107 lines (83 loc) · 7.36 KB

README.md

File metadata and controls

107 lines (83 loc) · 7.36 KB

CC-MIRROR Documentation

┌──────────────────────────────────────────────────────────────────────────────┐
│                                                                              │
│   ╭─────╮╭─────╮    ╭───╮╭───╮╭───╮╭───────╮╭───────╮╭───────╮╭───────╮     │
│   │ ╭───╯│ ╭───╯    │ ╭╮╯│ ╭─╯╰─╮ ││ ╭─╮ ╭─╯│ ╭─╮ ╭─╯│ ╭───╮ ││ ╭─╮ ╭─╯     │
│   │ │    │ │   ╭────│ ││ │ │  ╭─╯ ││ ╰─╯ │  │ ╰─╯ │  │ │   │ ││ ╰─╯ │       │
│   │ ╰───╮│ ╰───╯    │ ╰╯╭╯ ╰──╯ ╭─╯│ ╭─╮ │  │ ╭─╮ │  │ ╰───╯ ││ ╭─╮ │       │
│   ╰─────╯╰─────╯    ╰───╯╰──────╯  ╰─╯ ╰─╯  ╰─╯ ╰─╯  ╰───────╯╰─╯ ╰─╯       │
│                                                                              │
│   Create multiple isolated Claude Code variants with custom providers        │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

📚 Documentation Index

⚡ Getting Started

Document Description
Quick Start Install and create your first variant
CLI Options Commands, flags, and options

🤖 Features

Document Description
Mirror Claude Pure Claude Code with clean defaults

🏗️ Architecture

Document Description
Overview How cc-mirror works under the hood

🔧 Reference

Document Description
Tweakcc Guide Theme customization

🗺️ Quick Navigation

docs/
├── README.md                 ← You are here
├── TWEAKCC-GUIDE.md           # 🔧 tweakcc integration notes
├── features/
│   └── mirror-claude.md       # 🪞 Pure Claude Code variant
└── architecture/
    └── overview.md            # 🏗️ System architecture

💡 Quick Links

📊 Provider Comparison

┌──────────────┬────────────────────┬──────────────┬────────────┐
│   Provider   │       Model        │  Auth Mode   │ Prompt Pack│
├──────────────┼────────────────────┼──────────────┼────────────┤
│ kimi         │ kimi-for-coding    │ API Key      │ ✗          │
│ minimax      │ MiniMax-M2.5       │ API Key      │ ✓ Full     │
│ zai          │ GLM-5/4.7/4.5-Air  │ API Key      │ ✓ Full     │
│ openrouter   │ You choose         │ Auth Token   │ ✗          │
│ vercel       │ Vercel gateway     │ Auth Token   │ ✗          │
│ ollama       │ Local + cloud      │ Auth Token   │ ✗          │
│ nanogpt      │ Anthropic compat   │ Auth Token   │ ✗          │
│ ccrouter     │ Local LLMs         │ Optional     │ ✗          │
│ mirror       │ Claude (native)    │ OAuth/Key    │ ✗ Pure     │
│ gatewayz     │ GatewayZ gateway   │ Auth Token   │ ✗          │
└──────────────┴────────────────────┴──────────────┴────────────┘

🔗 Provider Setup Links

Provider Subscribe Get Key/Token Docs
kimi https://www.kimi.com/code https://www.kimi.com/code/console https://www.kimi.com/code/docs/en/more/third-party-agents.html
minimax https://platform.minimax.io/subscribe/coding-plan https://platform.minimax.io/user-center/payment/coding-plan https://platform.minimax.io/docs
zai https://z.ai/subscribe https://z.ai/manage-apikey/apikey-list https://z.ai/docs
openrouter https://openrouter.ai/account https://openrouter.ai/keys https://openrouter.ai/docs
vercel https://vercel.com/ai https://vercel.com/account/tokens https://vercel.com/docs/ai-gateway
ollama https://ollama.com https://ollama.com https://docs.ollama.com/api/anthropic-compatibility
nanogpt https://nano-gpt.com https://nano-gpt.com https://docs.nano-gpt.com/docs/anthropic-compatibility
ccrouter https://github.com/musistudio/claude-code-router#installation https://github.com/musistudio/claude-code-router#2-configuration https://github.com/musistudio/claude-code-router#2-configuration
gatewayz https://gatewayz.ai https://gatewayz.ai https://docs.gatewayz.ai/docs/anthropic-compatibility

Created by Numman Ali