Files
claude-code-glm-suite/README.md
uroma 5ec488d7ce Use @z_ai/coding-helper wizard for easier GLM setup
MAJOR IMPROVEMENT to GLM setup workflow:

Before: Manual configuration with multiple steps
- Create settings.json manually
- Copy/paste complex JSON
- Edit files manually
- Easy to make mistakes

After: Interactive wizard ( MUCH simpler!)
- npm install -g @z_ai/coding-helper
- npx @z_ai/coding-helper init
- Wizard asks for API key
- Everything configured automatically
- Verified working

Benefits:
-  Fewer steps (3 vs 6+)
-  Less error-prone
-  Interactive and guided
-  Official Z.AI tool
-  Automatic verification

Updates:
- MASTER-PROMPT.md: Promote wizard method as "EASIEST"
- README.md: Add wizard at top as primary method
- Blog post: Update warning with wizard commands
- Keep manual method as alternative

This makes GLM setup as simple as:
  npm install -g @z_ai/coding-helper
  npx @z_ai/coding-helper init
  claude
2026-01-15 15:05:58 +00:00

592 lines
17 KiB
Markdown

# 🚀 Ultimate Claude Code & GLM Suite
> 40+ specialized AI agents, MCP tools, auto-triggering automation for Claude Code. Works with Anthropic Claude and Z.AI/GLM models.
[![Agents](https://img.shields.io/badge/Agents-40+-purple)](agents/)
[![MCP Tools](https://img.shields.io/badge/MCP_Tools-15+-blue)](#mcp-tools)
[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
## 🚀 Quick Start
```bash
# Clone the repository
git clone https://github.rommark.dev/admin/claude-code-glm-suite.git
cd claude-code-glm-suite
# Run the interactive installer
chmod +x interactive-install-claude.sh
./interactive-install-claude.sh
# Follow the prompts:
# ✅ Choose model (Anthropic/Z.AI)
# ✅ Select agent categories to install
# ✅ Configure MCP tools
# ✅ Enter your API key
# ✅ Launch Claude Code
```
## 🎯 Installation Options
Choose the installation method that works best for you:
### ⚠️ IMPORTANT: For Z.AI / GLM Users
**If using the GLM Coding Plan (90% cheaper), you MUST configure GLM FIRST before using Claude Code!**
**🎯 EASIEST METHOD - Use Z.AI Coding Helper Wizard:**
```bash
# Install coding helper and run setup wizard
npm install -g @z_ai/coding-helper
npx @z_ai/coding-helper init
# The wizard will:
# ✅ Ask for your Z.AI API key
# ✅ Configure Claude Code for GLM automatically
# ✅ Set up model mappings (glm-4.5-air, glm-4.7)
# ✅ Verify everything works
# Start Claude Code with GLM
claude
```
**Manual Configuration (if you prefer):**
```bash
# Get API key: https://z.ai/
mkdir -p ~/.claude
cat > ~/.claude/settings.json << 'EOF'
{
"env": {
"ANTHROPIC_AUTH_TOKEN": "YOUR_ZAI_API_KEY_HERE",
"ANTHROPIC_BASE_URL": "https://api.z.ai/api/anthropic",
"API_TIMEOUT_MS": "3000000",
"ANTHROPIC_DEFAULT_HAIKU_MODEL": "glm-4.5-air",
"ANTHROPIC_DEFAULT_SONNET_MODEL": "glm-4.7",
"ANTHROPIC_DEFAULT_OPUS_MODEL": "glm-4.7"
}
}
EOF
npm install -g @anthropic-ai/claude-code
claude
```
---
### Option 1: Master Prompt (Recommended for First-Time Users)
**Copy and paste into Claude Code** - it will guide you through the entire installation step-by-step:
📄 **[MASTER-PROMPT.md](https://github.rommark.dev/admin/claude-code-glm-suite/src/main/MASTER-PROMPT.md)**
**⚡ Quick Start:**
1. **If using GLM:** Configure GLM first (see above)
2. Start Claude Code: `claude`
3. Copy the prompt from MASTER-PROMPT.md (clearly marked with ✂️ COPY FROM HERE)
4. Paste into Claude Code
5. Done!
**Benefits:**
- ✅ See all steps before executing
- ✅ Easy to customize and understand
- ✅ Works entirely within Claude Code
- ✅ Includes all source repository references
### Option 2: Interactive Installation Script
```bash
git clone https://github.rommark.dev/admin/claude-code-glm-suite.git
cd claude-code-glm-suite
chmod +x interactive-install-claude.sh
./interactive-install-claude.sh
```
**Benefits:**
- ✅ Automated execution
- ✅ Menu-driven configuration
- ✅ Backup and verification built-in
- ✅ Faster for experienced users
### Option 3: Manual Installation
Follow the step-by-step guide below for full control over each component.
---
## ✨ What's Included
- **🤖 40+ Custom Agents** across 8 categories
- **🔧 15+ MCP Tools** for vision, search, and GitHub integration
- **⚡ Auto-Triggering** test writer and UI enhancement agents
- **🎛️ Interactive Installation** with model selection (Anthropic/Z.AI)
- **🛡️ One-Click Setup** with comprehensive verification
## 📋 Complete Integration Guide
### Step 1: Choose Your Model Provider
Choose **Option A** (Anthropic) or **Option B** (Z.AI/GLM Plan) below.
---
### 🔵 Option A: Anthropic Claude (Official API)
**Best for:** Production, highest quality, official support
#### 1.1 Get Your API Key
```bash
# Visit: https://console.anthropic.com/
# Create an account and get your API key
```
#### 1.2 Configure Claude Code
```bash
# Create/update your Claude Code settings
mkdir -p ~/.claude
cat > ~/.claude/settings.json << 'EOF'
{
"env": {
"ANTHROPIC_AUTH_TOKEN": "sk-ant-your-actual-api-key-here",
"ANTHROPIC_BASE_URL": "https://api.anthropic.com"
}
}
EOF
```
#### 1.3 Install Claude Code (if not installed)
```bash
# Using npm
npm install -g @anthropic-ai/claude-code
# Or using curl
curl -fsSL https://claude.ai/install.sh | sh
```
#### 1.4 Verify Installation
```bash
# Test Claude Code
claude --version
# Test API connection
echo "Hello, Claude!" | claude
```
---
### 🟢 Option B: Z.AI / GLM Coding Plan (Cost-Effective)
**Best for:** Development, testing, cost savings (up to 90% cheaper)
**Official Documentation:** https://docs.z.ai/devpack/tool/claude
#### 1.1 Get Your API Key
```bash
# Visit: https://z.ai/
# Create an account and get your GLM Coding Plan API key
```
#### 1.2 Configure Claude Code for GLM
```bash
# Create/update your Claude Code settings
mkdir -p ~/.claude
cat > ~/.claude/settings.json << 'EOF'
{
"env": {
"ANTHROPIC_AUTH_TOKEN": "your-zai-api-key-here",
"ANTHROPIC_BASE_URL": "https://api.z.ai/api/anthropic",
"API_TIMEOUT_MS": "3000000",
"ANTHROPIC_DEFAULT_HAIKU_MODEL": "glm-4.5-air",
"ANTHROPIC_DEFAULT_SONNET_MODEL": "glm-4.7",
"ANTHROPIC_DEFAULT_OPUS_MODEL": "glm-4.7"
}
}
EOF
```
**GLM Models Available:**
- `glm-4.5-air` - Fast, efficient (Haiku equivalent)
- `glm-4.7` - High quality (Sonnet/Opus equivalent)
#### 1.3 Install Claude Code (if not installed)
```bash
# Install Claude Code (requires Node.js 18+)
npm install -g @anthropic-ai/claude-code
# Verify version (recommended: 2.0.14+)
claude --version
# Upgrade if needed
claude update
```
#### 1.4 Verify Installation
```bash
# Start Claude Code
claude
# Check model status (enter /status when prompted)
/status
# Troubleshooting:
# - Close all Claude Code windows and reopen
# - Or delete ~/.claude/settings.json and reconfigure
# - Verify JSON format is correct
```
---
### Step 2: Install This Customization Suite
```bash
# Clone this repository
git clone https://github.rommark.dev/admin/claude-code-glm-suite.git
cd claude-code-glm-suite
# Run the interactive installer
chmod +x interactive-install-claude.sh
./interactive-install-claude.sh
```
**The installer will:**
- ✅ Detect your Claude Code installation
- ✅ Backup existing customizations
- ✅ Let you choose agent categories to install
- ✅ Configure MCP tools
- ✅ Set up auto-triggering agents
- ✅ Verify everything works
**Installation options:**
```
Step 1: Model Selection
[ ] Already configured - skip model setup
[ ] Anthropic Claude (official API)
[ ] Z.AI / GLM Coding Plan
Step 2: Agent Categories
[ ] Engineering (7 agents) - RECOMMENDED
[ ] Marketing (7 agents)
[ ] Product (3 agents)
[ ] Project Management (3 agents)
[ ] Studio Operations (5 agents)
[ ] Testing (5 agents) - RECOMMENDED
[ ] Design (5 agents)
[ ] Bonus (2 agents)
Step 3: MCP Tools
[ ] Vision Tools (8 tools) - RECOMMENDED
[ ] Web Tools (search, reader)
[ ] GitHub Tools (zread)
Step 4: Plugins & Hooks
[ ] Auto-triggering agents
[ ] Custom hooks
```
---
### Step 3: Install MCP Tools (Optional but Recommended)
#### 3.1 Vision Tools (8 tools)
```bash
# Install Z.AI MCP server for vision tools
npm install -g @z_ai/mcp-server
# Verify installation
npx @z_ai/mcp-server --help
```
#### 3.2 Web & GitHub Tools
```bash
# Install Z.AI coding helper
npm install -g @z_ai/coding-helper
# Verify installation
npx @z_ai/coding-helper --help
```
---
### Step 4: Verify Your Installation
```bash
# Run the verification script
chmod +x verify-claude-setup.sh
./verify-claude-setup.sh
```
**Expected output:**
```
✅ Claude Code installed
✅ Settings configured
✅ Agents directory exists
✅ 37 agent files found
✅ MCP tools available
✅ Configuration valid
```
---
### Step 5: Test Your Setup
#### 5.1 Test Basic Functionality
```bash
# Start Claude Code
claude
# Try a simple command
> List all available agents
```
#### 5.2 Test an Agent
```bash
# In Claude Code, try:
> Use the frontend-developer agent to create a React component
```
#### 5.3 Test MCP Tools (if installed)
```bash
# In Claude Code, try:
> Analyze this image: [path to image]
> Search the web for "latest AI trends"
> Read the documentation from https://example.com
```
---
## 📦 Installation Scripts
| Script | Description | Size |
|--------|-------------|------|
| `interactive-install-claude.sh` | Full interactive installer (recommended) | 33KB |
| `claude-setup-manager.sh` | Menu-driven setup manager | 11KB |
| `create-complete-package.sh` | Create distributable packages | 16KB |
| `verify-claude-setup.sh` | Verify your installation | 9KB |
| `export-claude-customizations.sh` | Export existing customizations | 6.5KB |
---
## 🤖 Agent Categories
### Engineering (7 agents)
- **AI Engineer** - ML & LLM integration, prompt engineering
- **Backend Architect** - API design, database architecture, microservices
- **DevOps Automator** - CI/CD pipelines, infrastructure as code
- **Frontend Developer** - React/Vue/Angular, responsive design
- **Mobile Builder** - iOS/Android React Native apps
- **Rapid Prototyper** - Quick MVPs in 6-day cycles
- **Test Writer/Fixer** - Auto-write and fix tests
### Marketing (7 agents)
- **TikTok Strategist** - Viral TikTok marketing strategies
- **Growth Hacker** - Growth strategies and user acquisition
- **Content Creator** - Multi-platform content creation
- **Instagram Curator** - Instagram strategy and engagement
- **Reddit Builder** - Reddit community building
- **Twitter Engager** - Twitter strategy and tactics
- **App Store Optimizer** - ASO optimization
### Product (3 agents)
- **Feedback Synthesizer** - User feedback analysis
- **Sprint Prioritizer** - 6-day sprint planning
- **Trend Researcher** - Market trend analysis
### Project Management (3 agents)
- **Experiment Tracker** - A/B test tracking
- **Project Shipper** - Launch coordination
- **Studio Producer** - Team workflow optimization
### Studio Operations (5 agents)
- **Analytics Reporter** - Data analysis and reporting
- **Finance Tracker** - Financial tracking
- **Infrastructure Maintainer** - Infrastructure management
- **Legal Compliance Checker** - Compliance checks
- **Support Responder** - Customer support automation
### Testing (5 agents)
- **API Tester** - API testing
- **Performance Benchmarker** - Performance testing
- **Test Results Analyzer** - Test analysis
- **Tool Evaluator** - Tool evaluation
- **Workflow Optimizer** - Workflow optimization
### Design (5 agents)
- **Brand Guardian** - Brand consistency
- **UI Designer** - UI design and implementation
- **UX Researcher** - User experience research
- **Visual Storyteller** - Visual communication
- **Whimsy Injector** - Delightful UI enhancements
### Bonus (2 agents)
- **Joker** - Humor and team morale
- **Studio Coach** - Team coaching and motivation
---
## 🔧 MCP Tools
### Vision Tools (8 tools)
| Tool | Function | Input |
|------|----------|-------|
| `analyze_image` | General image analysis | PNG, JPG, JPEG |
| `analyze_video` | Video content analysis | MP4, MOV, M4V |
| `ui_to_artifact` | UI screenshot to code | Screenshots |
| `extract_text` | OCR text extraction | Any image |
| `diagnose_error` | Error screenshot diagnosis | Error screenshots |
| `ui_diff_check` | Compare UI screenshots | Before/after |
| `analyze_data_viz` | Data visualization insights | Dashboards, charts |
| `understand_diagram` | Technical diagram analysis | UML, flowcharts |
### Web & GitHub Tools
| Tool | Function | Source |
|------|----------|--------|
| `web-search-prime` | AI-optimized web search | [claude-codex-settings](https://github.com/fcakyon/claude-codex-settings) |
| `web-reader` | Web page to markdown conversion | [claude-codex-settings](https://github.com/fcakyon/claude-codex-settings) |
| `zread` | GitHub repository reader | [claude-codex-settings](https://github.com/fcakyon/claude-codex-settings) |
| `@z_ai/mcp-server` | Vision and analysis tools | [@z_ai/mcp-server](https://github.com/zai-ai/mcp-server) |
| `@z_ai/coding-helper` | Web and GitHub integration | [@z_ai/mcp-server](https://github.com/zai-ai/mcp-server) |
---
## 📚 Advanced Configuration
### Auto-Triggering Agents
This suite supports **two auto-triggering mechanisms**:
#### Method 1: Hooks-Based (Our Implementation)
Configure hooks.json for automatic agent invocation:
```bash
cat > ~/.claude/hooks.json << 'EOF'
{
"userPromptSubmitHook": "test-writer-fixer@agent",
"toolOutputHook": "whimsy-injector@agent"
}
EOF
```
#### Method 2: PROACTIVELY Keyword (Contains Studio Pattern)
Agents with `PROACTIVELY` in their description automatically trigger based on context:
```yaml
---
name: studio-coach
description: PROACTIVELY use this agent when complex multi-agent tasks begin...
---
```
**The 4 Proactive Agents:**
1. **studio-coach** - Triggers on complex multi-agent tasks
2. **test-writer-fixer** - Triggers after code modifications
3. **whimsy-injector** - Triggers after UI/UX changes
4. **experiment-tracker** - Triggers when feature flags are added
This method requires no hooks.json - Claude Code's built-in agent selection system detects the PROACTIVELY keyword and automatically invokes agents when matching conditions occur.
**Key Differences:**
| Feature | Hooks-Based | PROACTIVELY Keyword |
|---------|-------------|---------------------|
| Configuration | hooks.json file | Built into agent description |
| Trigger Scope | Global events | Context-aware conditions |
| Flexibility | Manual setup | Self-documenting |
| Detection | File/tool operations | Semantic context |
### Custom Model Selection
Use specific models for different tasks:
```bash
# Add to settings.json
{
"env": {
"MODEL_DEFAULT": "claude-sonnet-4-20250514",
"MODEL_FAST": "claude-haiku-4-20250514",
"MODEL_EXPENSIVE": "claude-opus-4-20250514"
}
}
```
---
## 📚 Documentation
- **[MASTER-PROMPT.md](MASTER-PROMPT.md)** - Copy-paste installation prompt for Claude Code
- **[INTEGRATION-GUIDE.md](INTEGRATION-GUIDE.md)** - Technical integration details
- **[CONTAINS-STUDIO-INTEGRATION.md](CONTAINS-STUDIO-INTEGRATION.md)** - PROACTIVELY auto-triggering explained
- **[CLAUDE-CUSTOMIZATIONS-README.md](CLAUDE-CUSTOMIZATIONS-README.md)** - Complete feature documentation
- **[FINAL-SETUP-GUIDE.md](FINAL-SETUP-GUIDE.md)** - Detailed setup instructions
- **[SCRIPTS-GUIDE.md](SCRIPTS-GUIDE.md)** - Script usage guide
---
## 🙏 Acknowledgments & Sources
This customization suite is built upon excellent open-source projects and community contributions.
### Core Inspiration
- **[contains-studio/agents](https://github.com/contains-studio/agents)** by [contains-studio](https://github.com/contains-studio)
- 37 specialized agents with PROACTIVELY auto-triggering system
- Inspired rich example format with <commentary> tags and 500+ word system prompts
- Source of studio-coach coordination patterns and department-based organization
- **[claude-codex-settings](https://github.com/fcakyon/claude-codex-settings)** by [fcakyon](https://github.com/fcakyon)
- Comprehensive Claude Code settings and MCP configurations
- Foundation for MCP tool integration patterns
- **[ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill)** by [nextlevelbuilder](https://github.com/nextlevelbuilder)
- Professional UI/UX design patterns and agent behaviors
- Inspired design-focused agents and whimsy-injector
- **[Ralph](https://github.com/iannuttall/ralph)** by [iannuttall](https://github.com/iannuttall)
- AI assistant framework and agent patterns
- Inspired multi-agent coordination and studio operations workflows
### MCP Tool Sources
- **[@z_ai/mcp-server](https://github.com/zai-ai/mcp-server)** - Vision analysis, OCR, UI comparison, video analysis, and diagram understanding
- **[Z.AI GLM Documentation](https://docs.z.ai/devpack/tool/claude)** - Official GLM Coding Plan integration guide for Claude Code
- **[Model Context Protocol](https://github.com/modelcontextprotocol)** - Open standard for connecting AI models to tools
- **[Claude Code](https://github.com/anthropics/claude-code)** - Official Claude Code CLI by Anthropic
### Agent Architecture
- **6-Day Development Cycle** - Inspired by rapid iteration methodologies and startup best practices
- **Studio Operations** - Professional studio management patterns applied to software development
- **Auto-Triggering Agents** - Proactive agent invocation patterns for test writing and UI enhancement
---
## 🤝 Community & Contributing
This suite is **100% open source** and available on [GitHub](https://github.rommark.dev/admin/claude-code-glm-suite).
- ⭐ Star the repo
- 🐛 Report issues
- 🔄 Submit pull requests
- 💡 Contribute your own agents!
---
## 📝 License
MIT License - Feel free to use and modify for your needs.
---
**Built for developers who ship.** 🚀