claude-flow-novice 1.0.0

package/wiki/getting-started/cli-access/README.md

@@ -0,0 +1,300 @@
+# CLI Access Guide
+
+Learn how to use Claude Flow Novice through the traditional command-line interface for direct terminal control and scripting.
+
+## 🎯 Overview
+
+CLI access provides direct command-line control over claude-flow-novice with full scripting capabilities and CI/CD integration.
+
+**Best for:**
+- Terminal-first developers
+- CI/CD pipeline integration
+- Batch processing and automation
+- Server environments
+
+## 🚀 Quick Setup
+
+```bash
+# Install globally
+npm install -g claude-flow-novice
+
+# Or use with npx (recommended)
+npx claude-flow@alpha --version
+
+# Initialize project
+npx claude-flow@alpha init
+```
+
+## 📋 Core CLI Commands
+
+### Agent Management
+```bash
+# List available agents
+npx claude-flow@alpha agents list
+
+# Spawn an agent
+npx claude-flow@alpha agents spawn coder "build REST API"
+
+# Check agent status
+npx claude-flow@alpha agents status
+```
+
+### SPARC Workflows
+```bash
+# Run full TDD workflow
+npx claude-flow@alpha sparc tdd "user authentication"
+
+# Run specific SPARC mode
+npx claude-flow@alpha sparc run architect "design microservices"
+
+# Batch multiple modes
+npx claude-flow@alpha sparc batch spec,arch "payment system"
+```
+
+### Swarm Coordination
+```bash
+# Initialize swarm
+npx claude-flow@alpha swarm init --topology mesh
+
+# Orchestrate task across swarm
+npx claude-flow@alpha swarm orchestrate "build full-stack app"
+
+# Monitor swarm activity
+npx claude-flow@alpha swarm monitor
+```
+
+## 🔧 Configuration
+
+### Project Configuration
+```bash
+# Generate config file
+npx claude-flow@alpha config init
+
+# Set preferences
+npx claude-flow@alpha config set agent.default coder
+npx claude-flow@alpha config set sparc.mode tdd
+
+# View configuration
+npx claude-flow@alpha config list
+```
+
+### Environment Variables
+```bash
+# Set in .env file
+CLAUDE_FLOW_API_KEY=your_key
+CLAUDE_FLOW_MODEL=claude-3.5-sonnet
+CLAUDE_FLOW_MAX_AGENTS=10
+```
+
+## 📂 Project Structure
+
+```
+my-project/
+├── .claude-flow/
+│   ├── config.json
+│   ├── agents/
+│   ├── memory/
+│   └── logs/
+├── src/
+├── tests/
+└── package.json
+```
+
+## 🎭 Agent Spawning Examples
+
+### Single Agent
+```bash
+# Spawn coder agent
+npx claude-flow@alpha agents spawn coder "implement user login"
+
+# With specific configuration
+npx claude-flow@alpha agents spawn reviewer \
+  --mode security \
+  --files "src/auth/*" \
+  "review authentication code"
+```
+
+### Multiple Agents
+```bash
+# Spawn coordinated team
+npx claude-flow@alpha agents spawn-team \
+  coder:"build API" \
+  tester:"write tests" \
+  reviewer:"security review"
+```
+
+## 🔄 SPARC CLI Workflows
+
+### Complete TDD Cycle
+```bash
+# Full cycle with monitoring
+npx claude-flow@alpha sparc tdd "shopping cart" \
+  --watch \
+  --coverage 90 \
+  --agents coder,tester,reviewer
+```
+
+### Custom Pipeline
+```bash
+# Custom SPARC sequence
+npx claude-flow@alpha sparc pipeline \
+  "spec → pseudocode → arch → tdd → integration" \
+  "payment processing system"
+```
+
+## 🎮 Interactive Mode
+
+```bash
+# Start interactive CLI
+npx claude-flow@alpha interactive
+
+# Interactive SPARC wizard
+npx claude-flow@alpha sparc wizard
+
+# Agent selection menu
+npx claude-flow@alpha agents wizard
+```
+
+## 🔗 Integration Examples
+
+### GitHub Integration
+```bash
+# Analyze repository
+npx claude-flow@alpha github analyze
+
+# Create PR with agent review
+npx claude-flow@alpha github pr-create \
+  --agents reviewer,tester \
+  --branch feature/auth
+```
+
+### CI/CD Integration
+```bash
+# Jenkins pipeline
+pipeline {
+    stage('AI Review') {
+        steps {
+            sh 'npx claude-flow@alpha agents spawn reviewer "review PR changes"'
+        }
+    }
+}
+
+# GitHub Actions
+- name: AI Code Review
+  run: npx claude-flow@alpha github pr-review --pr ${{ github.event.number }}
+```
+
+## 📊 Monitoring and Logs
+
+### Real-time Monitoring
+```bash
+# Monitor all agents
+npx claude-flow@alpha monitor
+
+# Monitor specific agent
+npx claude-flow@alpha monitor --agent coder-001
+
+# Export metrics
+npx claude-flow@alpha metrics export --format json
+```
+
+### Log Management
+```bash
+# View logs
+npx claude-flow@alpha logs show
+
+# Filter logs
+npx claude-flow@alpha logs show --level error --agent reviewer
+
+# Export logs
+npx claude-flow@alpha logs export --since "1 hour ago"
+```
+
+## 🛠️ Advanced CLI Features
+
+### Hooks System
+```bash
+# List available hooks
+npx claude-flow@alpha hooks list
+
+# Run pre-task hook
+npx claude-flow@alpha hooks pre-task --description "API development"
+
+# Custom hook configuration
+npx claude-flow@alpha hooks config set pre-edit "npm run lint"
+```
+
+### Memory Management
+```bash
+# View memory
+npx claude-flow@alpha memory show
+
+# Store data
+npx claude-flow@alpha memory store api-design "REST endpoints schema"
+
+# Retrieve data
+npx claude-flow@alpha memory get api-design
+```
+
+## 🎯 Best Practices
+
+### Command Structure
+```bash
+# Good: Clear, specific commands
+npx claude-flow@alpha agents spawn coder "implement JWT authentication"
+
+# Better: With context and constraints
+npx claude-flow@alpha agents spawn coder \
+  --context "Express.js API" \
+  --constraints "security-first" \
+  "implement JWT authentication with refresh tokens"
+```
+
+### Error Handling
+```bash
+# With retry logic
+npx claude-flow@alpha agents spawn coder "build API" \
+  --retry 3 \
+  --timeout 300
+
+# With fallback agent
+npx claude-flow@alpha agents spawn coder "complex task" \
+  --fallback reviewer
+```
+
+## 🚨 Troubleshooting
+
+### Common Issues
+```bash
+# Check CLI health
+npx claude-flow@alpha doctor
+
+# Reset configuration
+npx claude-flow@alpha config reset
+
+# Clear cache
+npx claude-flow@alpha cache clear
+```
+
+### Debug Mode
+```bash
+# Enable verbose output
+npx claude-flow@alpha --verbose agents spawn coder "debug task"
+
+# Debug specific component
+DEBUG=claude-flow:agents npx claude-flow@alpha agents list
+```
+
+## 📚 Further Reading
+
+- **[SPARC Methodology](../../core-concepts/sparc-methodology/README.md)** - Detailed workflow guide
+- **[Agent Reference](../../core-concepts/agents/README.md)** - Complete agent documentation
+- **[Command Reference](../../command-reference/README.md)** - Full command listing
+- **[Troubleshooting](../../troubleshooting/README.md)** - Common issues and solutions
+
+---
+
+**Next Steps:**
+- Try the [Quick Start Tutorial](../quick-start/README.md)
+- Explore [Core Concepts](../../core-concepts/README.md)
+- Practice with [Beginner Tutorials](../../tutorials/beginner/README.md)

package/wiki/getting-started/cli-access/first-commands.md

@@ -0,0 +1,319 @@
+# Your First CLI Commands
+
+**Get hands-on experience** with Claude Flow Novice CLI through these beginner-friendly commands. Perfect for your first 15 minutes!
+
+## 🎯 Prerequisites
+
+Ensure you have Claude Flow Novice installed:
+
+```bash
+# Check if installed
+claude-flow-novice --version
+
+# Or use npx (no installation needed)
+npx claude-flow-novice@latest --version
+```
+
+## 🚀 Command 1: Check System Health
+
+**Goal:** Verify everything is working correctly
+
+```bash
+# Check system status
+npx claude-flow-novice@latest doctor
+
+# Expected output:
+✅ Node.js version: 20.x.x
+✅ CLI installation: OK
+✅ Configuration: Default settings loaded
+✅ Dependencies: All packages available
+🎉 System ready for agent orchestration!
+```
+
+**What this does:**
+- Verifies your Node.js version compatibility
+- Checks CLI installation integrity
+- Validates configuration files
+- Tests dependency availability
+
+## 🤖 Command 2: List Available Agents
+
+**Goal:** See what AI agents you can work with
+
+```bash
+# List all available agent types
+npx claude-flow-novice@latest agents list
+
+# Expected output:
+🎭 Available Agents (54 total):
+
+Core Development:
+  • coder          - Write and refactor code
+  • reviewer       - Code quality and security review
+  • tester         - Test automation and coverage
+  • architect      - System design and planning
+
+Specialized:
+  • github         - Repository management
+  • api-docs       - API documentation
+  • performance    - Performance optimization
+  • security       - Security analysis
+
+[... and 46 more agents]
+```
+
+**What this does:**
+- Shows all 54+ available agent types
+- Displays each agent's specialization
+- Groups agents by category
+- Helps you choose the right agent for your task
+
+## 🌟 Command 3: Spawn Your First Agent
+
+**Goal:** Create your first AI agent to help with a simple task
+
+```bash
+# Spawn a coder agent to create a simple function
+npx claude-flow-novice@latest agent spawn coder "Create a JavaScript function that adds two numbers"
+
+# Expected output:
+🚀 Spawning Agent...
+Agent Type: coder
+Task: Create a JavaScript function that adds two numbers
+Agent ID: coder-001-20241126
+
+🤖 Agent coder-001 is working...
+📝 Creating function implementation...
+✅ Task completed successfully!
+
+📁 Output saved to: ./output/coder-001/add-numbers.js
+```
+
+**What this does:**
+- Spawns a specialized "coder" agent
+- Gives it a specific programming task
+- Shows real-time progress updates
+- Saves the generated code to a file
+
+**Check the result:**
+```bash
+# View the generated code
+cat ./output/coder-001/add-numbers.js
+
+# Should contain something like:
+/**
+ * Adds two numbers together
+ * @param {number} a - First number
+ * @param {number} b - Second number
+ * @returns {number} Sum of a and b
+ */
+function addNumbers(a, b) {
+  return a + b;
+}
+
+module.exports = { addNumbers };
+```
+
+## ⚡ Command 4: Initialize a Swarm
+
+**Goal:** Create a group of agents working together
+
+```bash
+# Initialize a simple mesh swarm with 3 agents
+npx claude-flow-novice@latest swarm init mesh --agents 3
+
+# Expected output:
+🕸️ Initializing Mesh Swarm...
+├── Agent 1: coordinator-001 (Coordination)
+├── Agent 2: analyst-002 (Analysis)
+└── Agent 3: optimizer-003 (Optimization)
+
+✅ Swarm initialized successfully!
+Swarm ID: mesh-swarm-001
+Topology: mesh (all agents connected)
+Status: Ready for tasks
+```
+
+**What this does:**
+- Creates a "mesh" topology where all agents can communicate
+- Spawns 3 different specialized agents automatically
+- Sets up coordination channels between agents
+- Prepares the swarm for collaborative tasks
+
+## 🔄 Command 5: Run a Simple SPARC Workflow
+
+**Goal:** Experience the SPARC methodology for structured development
+
+```bash
+# Run a simple specification workflow
+npx claude-flow-novice@latest sparc run spec "Build a todo list application"
+
+# Expected output:
+📋 Running SPARC Specification Phase...
+
+🎯 Analyzing Requirements...
+✅ User Stories: 5 identified
+✅ Acceptance Criteria: 12 defined
+✅ Technical Requirements: 8 specified
+✅ Architecture Constraints: 3 noted
+
+📝 Specification Complete!
+Output: ./sparc-output/spec-todo-app.md
+
+⏭️ Next Phase: Run 'sparc run pseudocode' to continue
+```
+
+**What this does:**
+- Runs the "Specification" phase of SPARC methodology
+- Analyzes requirements for a todo application
+- Generates user stories and acceptance criteria
+- Creates a foundation for the next development phases
+
+**View the specification:**
+```bash
+# Check the generated specification
+cat ./sparc-output/spec-todo-app.md
+```
+
+## 📊 Command 6: Monitor Agent Activity
+
+**Goal:** Watch your agents work in real-time
+
+```bash
+# Monitor all active agents
+npx claude-flow-novice@latest monitor
+
+# Expected output:
+📊 Agent Activity Monitor (Press Ctrl+C to exit)
+
+Active Agents: 1
+┌─────────────┬──────────┬────────────┬─────────────────┐
+│ Agent ID    │ Type     │ Status     │ Current Task    │
+├─────────────┼──────────┼────────────┼─────────────────┤
+│ coder-001   │ coder    │ Working    │ Adding numbers  │
+└─────────────┴──────────┴────────────┴─────────────────┘
+
+Memory Usage: 45.2 MB
+Task Queue: 0 pending
+Last Update: 2024-11-26 10:30:15
+```
+
+**What this does:**
+- Shows all currently active agents
+- Displays their current status and tasks
+- Monitors system resource usage
+- Updates information in real-time
+
+## 🎭 Command 7: Multi-Agent Collaboration
+
+**Goal:** See multiple agents working together on a complex task
+
+```bash
+# Orchestrate a task across your swarm
+npx claude-flow-novice@latest task orchestrate "Create a simple web server with tests"
+
+# Expected output:
+🎯 Orchestrating Task Across Swarm...
+
+Swarm Analysis:
+├── Breaking down task into subtasks...
+├── Assigning agents based on expertise...
+└── Setting up coordination protocols...
+
+Agent Assignments:
+🤖 coder-001: Implement Express.js server
+🧪 tester-002: Write unit and integration tests
+👀 reviewer-003: Review code quality and security
+
+🚀 Task execution started...
+[Live updates will show progress]
+```
+
+**What this does:**
+- Automatically breaks down complex tasks
+- Assigns subtasks to specialized agents
+- Coordinates work between multiple agents
+- Provides real-time progress updates
+
+## 💾 Command 8: Check Memory and Results
+
+**Goal:** Review what your agents have learned and created
+
+```bash
+# View agent memory
+npx claude-flow-novice@latest memory show
+
+# Check recent outputs
+npx claude-flow-novice@latest results list
+
+# Expected output:
+🧠 Agent Memory Contents:
+├── api-patterns/
+├── code-examples/
+├── test-strategies/
+└── project-configs/
+
+📂 Recent Results (last 24h):
+├── add-numbers.js (coder-001)
+├── spec-todo-app.md (sparc-spec)
+├── server-tests.js (tester-002)
+└── security-review.md (reviewer-003)
+```
+
+**What this does:**
+- Shows what information agents have stored
+- Lists recent outputs and generated files
+- Helps you track progress across sessions
+- Demonstrates persistent memory capabilities
+
+## 🎉 Success! What You Just Learned
+
+Congratulations! You've just completed your first Claude Flow Novice session. Here's what you accomplished:
+
+### ✅ Core Skills Gained:
+- **System verification** - Checking CLI health
+- **Agent discovery** - Finding the right AI agents for tasks
+- **Single agent spawning** - Creating specialized AI workers
+- **Swarm coordination** - Orchestrating multiple agents
+- **SPARC methodology** - Structured development approach
+- **Real-time monitoring** - Watching agents work
+- **Task orchestration** - Complex multi-agent collaboration
+- **Memory management** - Accessing agent knowledge and outputs
+
+### 🎯 Key Concepts Mastered:
+- **Agents**: Specialized AI workers (coder, tester, reviewer, etc.)
+- **Swarms**: Groups of agents working together
+- **SPARC**: Systematic development methodology
+- **Orchestration**: Coordinating complex tasks across agents
+- **Memory**: Persistent storage of agent knowledge and outputs
+
+## 🚀 Next Steps
+
+Now that you've mastered the basics, here's your learning progression:
+
+### Immediate Next Steps (Today):
+1. **[Try the Quick Start Tutorial](../quick-start/cli-tutorial.md)** - Build a real project
+2. **[Explore SPARC Methodology](../../core-concepts/sparc-methodology/README.md)** - Learn structured development
+3. **[Practice with Examples](../../examples/basic-projects/README.md)** - Hands-on projects
+
+### This Week:
+1. **[Learn Advanced CLI Commands](../../command-reference/cli/README.md)** - Master all features
+2. **[Understand Agent Specializations](../../core-concepts/agents/README.md)** - Choose the right agents
+3. **[Try Complex Workflows](../../tutorials/intermediate/README.md)** - Multi-step projects
+
+### This Month:
+1. **[GitHub Integration](../../tutorials/advanced/github-integration/README.md)** - Automate repository workflows
+2. **[CI/CD Pipelines](../../tutorials/advanced/ci-cd/README.md)** - Production automation
+3. **[Custom Agents](../../tutorials/expert/custom-agents/README.md)** - Build specialized agents
+
+## 🆘 Need Help?
+
+- **Stuck on a command?** Check [Troubleshooting](../../troubleshooting/cli-issues.md)
+- **Want more examples?** Browse [Command Reference](../../command-reference/cli/README.md)
+- **Ready for projects?** Try [Quick Start Tutorial](../quick-start/cli-tutorial.md)
+
+---
+
+**🎊 Congratulations! You're now ready to orchestrate AI agents like a pro!**
+
+**Next:** [Try the Complete Quick Start Tutorial →](../quick-start/cli-tutorial.md)