claude-hub/docs

Claude Hub Documentation

Welcome to the Claude GitHub Webhook service documentation! This service enables Claude AI to respond to GitHub events and automate repository workflows.

📋 Quick Start Guides

For Developers with Claude Subscriptions

💡 Recommended for personal projects and development

You can use your existing Claude Max subscription (5x or 20x plans) instead of paying API fees:

1. Setup Container Authentication - Use your subscription for automation
2. Complete Authentication Guide - All authentication methods

For Production and Teams

🏢 Recommended for production applications

• ANTHROPIC_API_KEY Setup - Direct API key authentication
• AWS Bedrock Setup - Enterprise-grade deployment

🚀 Key Features

GitHub Integration

• Auto-tagging: Automatically categorize and label new issues
• PR Reviews: Comprehensive automated pull request reviews
• Webhook Responses: Claude responds to mentions in issues and PRs
• CLI Access: Direct command-line interface for testing

Authentication Flexibility

• Personal: Use Claude Max subscriptions (5x or 20x plans) via setup container
• Production: ANTHROPIC_API_KEY for stable production usage
• Enterprise: AWS Bedrock integration for compliance and scale

Security & Reliability

• Container Isolation: Secure execution environment
• Credential Management: Multiple secure authentication methods
• Rate Limiting: Built-in protection against abuse
• Logging: Comprehensive audit trail

📚 Documentation Index

Getting Started

• Main README - Project overview and basic setup
• CLAUDE.md - Complete build and run commands
• Authentication Guide - Choose your auth method

Authentication Methods

• Setup Container Guide - Use your Claude subscription
• AWS Authentication - Enterprise AWS setup
• Credential Security - Security best practices

Workflows & CI/CD

• Complete Workflow - End-to-end process documentation
• GitHub Workflow - GitHub-specific integration
• Docker CI/CD - Container deployment
• PR Review Workflow - Automated code reviews

Container & Deployment

• Container Setup - Docker configuration
• Container Limitations - Known constraints
• Docker Optimization - Performance tuning

Security & Operations

• Logging Security - Secure logging practices
• Pre-commit Setup - Code quality automation
• Scripts Documentation - Available utility scripts

💰 Cost Comparison

Usage Level	Setup Container	API Key	AWS Bedrock
Light (< 1M tokens/month)	$100-200/month (Max 5x/20x)	~$15/month	~$20/month
Medium (1-10M tokens/month)	$100-200/month (Max 5x/20x)	$150-1500/month	$150-1500/month
Heavy (10M+ tokens/month)	$100-200/month (Max 5x/20x)	$1500+/month	$1500+/month

💡 Pro Tip: If you're already paying for Claude Max subscriptions (5x or 20x plans), the setup container method lets you use your existing subscription for automation at no additional cost!

🎯 Use Case Recommendations

Individual Developers

• Start with: Setup Container (use your Claude subscription)
• Scale to: API Key if you need higher stability

Small Teams (2-10 developers)

• Recommended: ANTHROPIC_API_KEY
• Budget option: Multiple setup containers for different team members

Enterprise (10+ developers)

• Recommended: AWS Bedrock
• Alternative: ANTHROPIC_API_KEY with enterprise support

🔧 Quick Commands

Authentication Setup

# Personal/Development (use Claude subscription)
./scripts/setup/setup-claude-interactive.sh

# Production (API key)
echo "ANTHROPIC_API_KEY=sk-ant-your-key" >> .env

# Enterprise (AWS Bedrock)
./scripts/aws/create-aws-profile.sh

Service Management

# Start services
docker compose up -d

# View logs
docker compose logs -f webhook

# Restart services
docker compose restart webhook

# Test webhook
node cli/webhook-cli.js --repo "owner/repo" --command "Hello Claude!" --url "http://localhost:8082"

Development

# Run tests
npm test

# Type checking
npm run typecheck

# Linting
npm run lint

# Build
npm run build

🆘 Support & Troubleshooting

Common Issues

1. Authentication Problems: See Authentication Guide
2. Container Issues: Check Container Limitations
3. GitHub Integration: Review GitHub Workflow
4. Performance: Consult Docker Optimization

Getting Help

• Documentation: Check the relevant guide above
• Logs: Use docker compose logs -f webhook for debugging
• Testing: Use CLI tools for isolated testing
• Community: Share experiences and solutions

🚀 Innovation Highlights

Setup Container Method

Our setup container approach is a breakthrough innovation that allows Claude Max/20x subscribers to use their existing subscriptions for automation - potentially saving thousands of dollars compared to API usage.

Multi-tier Authentication

Flexible authentication supports everything from personal development ($20/month) to enterprise deployment with full compliance and security.

Production Ready

Built for real-world usage with comprehensive logging, security, container isolation, and monitoring capabilities.

---

Get started today: Choose your authentication method and follow the corresponding guide above! 🚀