Initial commit: Claude Code Customization Suite - 40+ agents, MCP tools, and automation scripts
This commit is contained in:
uroma
353
FINAL-SETUP-GUIDE.md
Normal file
353
FINAL-SETUP-GUIDE.md
Normal file
@@ -0,0 +1,353 @@
|
||||
# Claude Code Customizations - Complete Setup Guide
|
||||
|
||||
## 📦 All Scripts Created
|
||||
|
||||
| Script | Size | Description |
|
||||
|--------|------|-------------|
|
||||
| **interactive-install-claude.sh** | 28KB | ⭐ **NEW** - Interactive step-by-step installer |
|
||||
| claude-setup-manager.sh | 11KB | Interactive menu manager |
|
||||
| create-complete-package.sh | 16KB | Create full distributable package |
|
||||
| install-claude-customizations.sh | 13KB | Automated installer (original) |
|
||||
| export-claude-customizations.sh | 6.5KB | Export/backup customizations |
|
||||
| verify-claude-setup.sh | 9.2KB | Verify installation |
|
||||
|
||||
## 🚀 Quick Start - Choose Your Method
|
||||
|
||||
### Method 1: Interactive Installer (Recommended) ⭐
|
||||
|
||||
The easiest way to install - guides you through each step:
|
||||
|
||||
```bash
|
||||
./interactive-install-claude.sh
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- ✅ Choose model provider (Anthropic or Z.AI)
|
||||
- ✅ Select which agent categories to install
|
||||
- ✅ Choose which MCP tools to install
|
||||
- ✅ Select plugins and hooks
|
||||
- ✅ **Installs Claude Code if not present**
|
||||
- ✅ Launches Claude Code when done
|
||||
|
||||
### Method 2: Menu Manager
|
||||
|
||||
```bash
|
||||
./claude-setup-manager.sh
|
||||
```
|
||||
|
||||
Provides an interactive menu for all operations.
|
||||
|
||||
### Method 3: Package Distribution
|
||||
|
||||
For distributing to other machines:
|
||||
|
||||
```bash
|
||||
# On source machine - create package
|
||||
./create-complete-package.sh
|
||||
|
||||
# On target machine - extract and run
|
||||
tar -xzf claude-customizations-complete-*.tar.gz
|
||||
cd claude-complete-package
|
||||
./install.sh
|
||||
./verify.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 What Gets Installed
|
||||
|
||||
### Step-by-Step Selection
|
||||
|
||||
The interactive installer guides you through:
|
||||
|
||||
#### **Step 1: Model Provider**
|
||||
- Anthropic Claude (official) - Get API key from https://console.anthropic.com/
|
||||
- Z.AI / GLM Coding Plan - Get API key from https://open.bigmodel.cn/usercenter/apikeys
|
||||
|
||||
The script will prompt for your API key with helpful information about where to get it based on your choice.
|
||||
|
||||
#### **Step 2: Agent Categories** (40+ agents)
|
||||
- Engineering (7): AI engineer, frontend/backend dev, DevOps, mobile, rapid prototyper, test writer
|
||||
- Marketing (7): TikTok strategist, growth hacker, content creator, Instagram/Reddit/Twitter
|
||||
- Product (3): Sprint prioritizer, feedback synthesizer, trend researcher
|
||||
- Studio Operations (8): Studio producer, project shipper, analytics, finance, legal, support, coach
|
||||
- Project Management (3): Experiment tracker, studio producer, project shipper
|
||||
- Testing (5): Test writer/fixer, API tester, performance benchmarker, workflow optimizer
|
||||
- Design (5): UI/UX designer, brand guardian, visual storyteller, whimsy injector
|
||||
- Bonus (2): Joker, studio coach
|
||||
|
||||
#### **Step 3: MCP Tools**
|
||||
- Vision Analysis (8 tools): images, videos, UI screenshots, errors, data viz, diagrams
|
||||
- Web Search: enhanced search with filtering
|
||||
- Web Reader: fetch URLs, convert to markdown
|
||||
- GitHub Reader: read repos, search docs
|
||||
|
||||
#### **Step 4: Plugins**
|
||||
- glm-plan-bug: Submit bug feedback
|
||||
- glm-plan-usage: Query usage stats
|
||||
|
||||
#### **Step 5: Hooks**
|
||||
- Custom automation hooks
|
||||
|
||||
#### **Step 6: Prerequisites Check**
|
||||
- Node.js, npm, python3, npx
|
||||
|
||||
#### **Step 7: Claude Code Installation** ⭐ NEW
|
||||
- Install via npm (recommended)
|
||||
- Install via curl (standalone binary)
|
||||
- Manual installation link
|
||||
- Skip if already installed
|
||||
|
||||
#### **Step 8: Backup**
|
||||
- Backs up existing configuration
|
||||
|
||||
#### **Step 9: Installation**
|
||||
- Creates directory structure
|
||||
- Installs selected agents
|
||||
- Configures settings
|
||||
- Installs MCP tools
|
||||
- Configures plugins
|
||||
|
||||
#### **Step 10: Summary & Launch**
|
||||
- Shows what was installed
|
||||
- Offers to launch Claude Code
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Installation Examples
|
||||
|
||||
### Example 1: Fresh Machine (No Claude Code)
|
||||
|
||||
```bash
|
||||
./interactive-install-claude.sh
|
||||
```
|
||||
|
||||
The script will:
|
||||
1. Detect Claude Code is not installed
|
||||
2. Offer to install it (npm, curl, or manual)
|
||||
3. Guide you through selecting components
|
||||
4. Install everything
|
||||
5. Launch Claude Code
|
||||
|
||||
### Example 2: Existing Claude Code
|
||||
|
||||
```bash
|
||||
./interactive-install-claude.sh
|
||||
```
|
||||
|
||||
The script will:
|
||||
1. Detect existing installation
|
||||
2. Offer to back up current config
|
||||
3. Guide you through selecting components
|
||||
4. Merge with existing setup
|
||||
5. Restart Claude Code
|
||||
|
||||
### Example 3: Minimal Installation
|
||||
|
||||
```bash
|
||||
./interactive-install-claude.sh
|
||||
```
|
||||
|
||||
Select:
|
||||
- Model: Anthropic
|
||||
- Agents: Engineering only
|
||||
- MCP Tools: Vision only
|
||||
- Plugins: No
|
||||
- Hooks: No
|
||||
|
||||
→ Gets you started with just the essentials
|
||||
|
||||
### Example 4: Full Installation
|
||||
|
||||
```bash
|
||||
./interactive-install-claude.sh
|
||||
```
|
||||
|
||||
Select:
|
||||
- Model: Z.AI
|
||||
- Agents: All categories
|
||||
- MCP Tools: All tools
|
||||
- Plugins: Yes
|
||||
- Hooks: Yes
|
||||
|
||||
→ Complete setup with all features
|
||||
|
||||
---
|
||||
|
||||
## 📁 File Locations
|
||||
|
||||
All scripts are in: `/home/uroma/`
|
||||
|
||||
```
|
||||
/home/uroma/
|
||||
├── interactive-install-claude.sh ⭐ NEW - Main installer
|
||||
├── claude-setup-manager.sh - Menu manager
|
||||
├── create-complete-package.sh - Package creator
|
||||
├── install-claude-customizations.sh - Original installer
|
||||
├── export-claude-customizations.sh - Export tool
|
||||
├── verify-claude-setup.sh - Verification
|
||||
├── CLAUDE-CUSTOMIZATIONS-README.md - Feature docs
|
||||
├── SCRIPTS-GUIDE.md - Script usage
|
||||
└── FINAL-SETUP-GUIDE.md - This file
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Advanced Usage
|
||||
|
||||
### Create Custom Package
|
||||
|
||||
```bash
|
||||
# 1. Create package with your selections
|
||||
./interactive-install-claude.sh
|
||||
|
||||
# 2. Package up for distribution
|
||||
./create-complete-package.sh
|
||||
```
|
||||
|
||||
### Transfer Between Machines
|
||||
|
||||
```bash
|
||||
# On source machine
|
||||
./create-complete-package.sh
|
||||
scp claude-customizations-complete-*.tar.gz target:~/
|
||||
|
||||
# On target machine
|
||||
./interactive-install-claude.sh # Will install Claude Code if needed
|
||||
```
|
||||
|
||||
### Verify Installation
|
||||
|
||||
```bash
|
||||
./verify-claude-setup.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Troubleshooting
|
||||
|
||||
### Claude Code not found?
|
||||
→ Run `./interactive-install-claude.sh` - it will offer to install Claude Code
|
||||
|
||||
### Agents not showing?
|
||||
→ Run `./verify-claude-setup.sh` to check installation
|
||||
|
||||
### MCP tools not working?
|
||||
→ Make sure `@z_ai/mcp-server` is installed:
|
||||
```bash
|
||||
npm list -g @z_ai/mcp-server
|
||||
npm install -g @z_ai/mcp-server
|
||||
```
|
||||
|
||||
### Permission errors?
|
||||
→ Check `~/.claude/settings.local.json` for allowed commands
|
||||
|
||||
### Need to start over?
|
||||
```bash
|
||||
# Backup is saved at ~/.claude-backup-YYYYMMDD_HHMMSS
|
||||
rm -rf ~/.claude
|
||||
./interactive-install-claude.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 What Each Script Does
|
||||
|
||||
### interactive-install-claude.sh ⭐
|
||||
**NEW - Main Recommended Script**
|
||||
|
||||
- Step-by-step interactive installation
|
||||
- Choose model provider (Anthropic/Z.AI)
|
||||
- Select which components to install
|
||||
- Installs Claude Code if missing
|
||||
- Launches Claude Code when done
|
||||
|
||||
**Best for:** New installations, first-time setup
|
||||
|
||||
### claude-setup-manager.sh
|
||||
Interactive menu for:
|
||||
- Creating packages
|
||||
- Installing customizations
|
||||
- Exporting backups
|
||||
- Verifying setup
|
||||
- Viewing documentation
|
||||
- Cleaning backups
|
||||
|
||||
**Best for:** Ongoing management
|
||||
|
||||
### create-complete-package.sh
|
||||
Creates a complete package with:
|
||||
- All agent .md files
|
||||
- Plugin configurations
|
||||
- Settings templates
|
||||
- Self-contained install.sh
|
||||
- Verification script
|
||||
|
||||
**Best for:** Distributing to other machines
|
||||
|
||||
### install-claude-customizations.sh
|
||||
Original automated installer:
|
||||
- Creates directory structure
|
||||
- Installs agents
|
||||
- Configures settings
|
||||
- Installs MCP tools
|
||||
- Sets up plugins
|
||||
|
||||
**Best for:** Automated setups, scripting
|
||||
|
||||
### export-claude-customizations.sh
|
||||
Exports existing customizations:
|
||||
- Copies agent definitions
|
||||
- Exports plugin configs
|
||||
- Creates settings template
|
||||
- Packages into .tar.gz
|
||||
|
||||
**Best for:** Backups, transfers
|
||||
|
||||
### verify-claude-setup.sh
|
||||
Verifies installation:
|
||||
- Checks directories
|
||||
- Counts agents
|
||||
- Validates settings
|
||||
- Tests MCP tools
|
||||
- Checks plugins
|
||||
|
||||
**Best for:** Troubleshooting
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Quick Reference
|
||||
|
||||
### To install everything:
|
||||
```bash
|
||||
./interactive-install-claude.sh
|
||||
```
|
||||
|
||||
### To create distribution package:
|
||||
```bash
|
||||
./create-complete-package.sh
|
||||
```
|
||||
|
||||
### To verify installation:
|
||||
```bash
|
||||
./verify-claude-setup.sh
|
||||
```
|
||||
|
||||
### To manage existing setup:
|
||||
```bash
|
||||
./claude-setup-manager.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support
|
||||
|
||||
For detailed documentation:
|
||||
- `CLAUDE-CUSTOMIZATIONS-README.md` - Complete feature docs
|
||||
- `SCRIPTS-GUIDE.md` - Script usage guide
|
||||
|
||||
---
|
||||
|
||||
**Version:** 2.0.0
|
||||
**Last Updated:** 2025-01-15
|
||||
**What's New:** Interactive installer with Claude Code installation support
|
||||
Reference in New Issue
Block a user