ai-workflow-tools/README.md

AI-powered development workflow CLI tools - streamline your development process with intelligent automation

# AI Development Workflow CLI Tools

A comprehensive set of command-line tools to streamline AI-first development workflows. These tools help manage personas, integrate AI services, and track workflow progress.

## 🚀 Quick Start

### Installation

Install globally via npm:

```bash
npm install -g ai-workflow-tools
```

### Available Commands

After installation, you'll have access to three powerful CLI tools:

- `pc` - Persona Manager CLI
- `aiw` - AI Integration CLI  
- `wt` - Workflow Tracker CLI

## 📋 Tools Overview

### 🎭 Persona Manager (`pc`)

Manage development personas and project workflows.

```bash
# Initialize a new project
pc init my-project --type webapp

# List available personas
pc list

# Get persona details
pc get-persona frontend-developer

# Start a workflow phase
pc start-phase design

# Complete current phase
pc complete-phase

# Check project status
pc status
```

### 🤖 AI Integration (`aiw`)

Integrate with various AI providers and manage AI-powered development.

```bash
# Setup AI provider
aiw setup --provider openai --api-key your-key

# Start AI chat session
aiw chat

# Generate code with AI
aiw generate --type component --name UserCard

# View conversation history
aiw history

# Export session data
aiw export --format json
```

### 📊 Workflow Tracker (`wt`)

Track project progress and generate workflow reports.

```bash
# Initialize workflow tracking
wt init

# Show current status
wt status

# Update task progress
wt update-task "Setup database" --status completed --hours 3

# Generate progress report
wt report
```

## 🛠️ Configuration

### AI Providers

The AI Integration tool supports multiple providers:

- **OpenAI**: GPT-3.5, GPT-4, GPT-4 Turbo
- **Anthropic**: Claude 3 (Haiku, Sonnet, Opus)
- **Local**: Ollama for local AI models

### Project Types

Persona Manager supports various project templates:

- `webapp` - Web application
- `mobile` - Mobile application
- `api` - REST API service
- `saas` - SaaS dashboard
- `custom` - Custom project type

### Workflow Phases

Standard workflow phases include:

1. **Discovery & Planning** - Requirements gathering and project planning
2. **Design & Prototyping** - UI/UX design and prototyping
3. **Development Setup** - Environment and tooling setup
4. **Implementation** - Core development work
5. **Deployment & Monitoring** - Production deployment and monitoring

## 📁 Templates

The package includes comprehensive templates for:

### Persona Templates
- Frontend Developer
- Backend Developer
- DevOps Engineer
- UX Designer
- Product Manager
- QA Engineer
- Data Scientist
- Mobile Developer

### Project Templates
- Basic Web Application
- SaaS Dashboard
- Mobile Application
- API Service

### Prompt Templates
- Development prompts
- Design prompts
- Deployment prompts

## 🔧 Advanced Usage

### Environment Variables

```bash
# AI Integration
export OPENAI_API_KEY="your-openai-key"
export ANTHROPIC_API_KEY="your-anthropic-key"
export OLLAMA_BASE_URL="http://localhost:11434"

# Workflow Tracking
export WORKFLOW_DATA_DIR="./workflow-data"
```

### Configuration Files

The tools create configuration files in your project:

- `.ai-workflow-config.json` - AI provider settings
- `.workflow-tracking.json` - Progress tracking data
- `.persona-config.json` - Project persona settings

## 📖 Documentation

For detailed documentation, visit:

- [Setup Guide](./SETUP_GUIDE.md)
- [CLI Installation Guide](./CLI_INSTALLATION_GUIDE.md)
- [Troubleshooting](./TROUBLESHOOTING.md)

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](https://github.com/joe-glasgow/ai-development-workflow/blob/main/CONTRIBUTING.md) for details.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

## 🔗 Related Projects

- [AI Development Workflow](https://github.com/joe-glasgow/ai-development-workflow) - Main project repository
- [AI Workflow GUI](https://github.com/joe-glasgow/ai-workflow-gui) - Web-based GUI for these tools

## 📞 Support

- 📧 Email: support@ai-workflow.dev
- 🐛 Issues: [GitHub Issues](https://github.com/joe-glasgow/ai-workflow-tools/issues)
- 💬 Discussions: [GitHub Discussions](https://github.com/joe-glasgow/ai-workflow-tools/discussions)

---

Made with ❤️ for AI-first developers