Package Exports
- ai-workflow-utils
- ai-workflow-utils/dist/server.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ai-workflow-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
π AI Workflow Utils
The Ultimate AI-Powered Development Workflow Automation Platform
Streamline your development process with intelligent Jira ticket creation, AI-powered code reviews & pull request creation, and seamless attachment management
π NEW IN v1.x.x - Game-Changing Features!
π― Feature #1: AI-Powered Jira Ticket Creation
Create professional Jira tickets (Tasks, Bugs, Stories) using AI with multiple provider support:
- π€ OpenAI Compatible APIs: GPT-4, Claude, and other cloud providers
- π Local AI with Ollama LLaVA: Complete privacy with local image analysis
- πΈ Smart Image Analysis: Upload screenshots and get detailed issue descriptions
- β‘ Real-time Streaming: Watch AI generate content live
- π¨ Professional Templates: Auto-formatted with proper sections and acceptance criteria
- π Direct Jira Integration: Creates tickets instantly with your access token
π Feature #2: AI-Powered Pull Request Creation
Revolutionary AI-powered pull request creation for Atlassian Bitbucket:
- π€ Intelligent PR Generation: AI analyzes commit messages to create professional PR titles and descriptions
- π Smart Commit Analysis: Automatically determines PR type (feat/fix/chore) based on commit patterns
- β‘ Real-time Streaming: Watch AI generate PR content live with streaming updates
- π Multi-Model Support: Uses Ollama for local AI processing with privacy
- βοΈ Editable Previews: Review and edit AI-generated content before creating the PR
- π― Ticket Integration: Automatically includes ticket numbers in PR titles
- πΎ Smart Persistence: Remembers project and repository settings for faster workflow
π Feature #3: GitStash PR AI Review
Revolutionary AI-powered pull request reviews for Atlassian Bitbucket:
- π§ Intelligent Code Analysis: AI reviews your code changes
- π‘ Smart Suggestions: Get actionable improvement recommendations
- π Multi-Model Support: OpenAI Compatible APIs + Ollama for flexibility
- π Automated Comments: AI adds review comments directly to your PRs
- β‘ Coming Soon: Direct comment integration (currently in development)
π Feature #4: Simple Jira Attachment Management
Effortless file management for your Jira tickets:
- π Drag & Drop Interface: Simple file uploads
- π₯ Video Conversion: Automatic .mov to .mp4 conversion
- πΈ Image Optimization: Smart image processing
- π Direct Integration: Seamless attachment to existing tickets
Hereβs a cleaned-up and renumbered version of your βQuick Start Guideβ section for the README. All step numbers are sequential, and optional sub-steps are clearly labeled. Copy-paste this to replace your existing section:
π Quick Start Guide
Step 1: Recommended - Ollama Setup (For Local AI)
# Install Ollama (if you want local AI processing)
# macOS
brew install ollama
# Linux
curl -fsSL https://ollama.com/install.sh | sh
# Windows - Download from https://ollama.com/
# Download the LLaVA model for image analysis
ollama pull llava
# Start Ollama service
ollama serve
Then configure Ollama as your AI provider in the web interface.
Step 2: Installation
npm install -g ai-workflow-utils
Step 3: Launch the Application
# Start the application directly
ai-workflow-utils
The application will start immediately and be available at http://localhost:3000
Step 4: (Optional) Install as Startup Service
For production use or to run automatically on system boot:
ai-workflow-utils startup install
The service will now start automatically on boot. Access at http://localhost:3000
Startup Service Management:
ai-workflow-utils startup status # Check service status
ai-workflow-utils startup start # Start the service
ai-workflow-utils startup stop # Stop the service
ai-workflow-utils startup uninstall # Remove startup service
Supported Platforms:
- macOS: Uses LaunchAgents (user-level service)
- Windows: Uses Windows Service Manager
- Linux: Uses systemd
For detailed startup service documentation, see STARTUP.md
Step 5: Configure Using the Settings Page
All configuration is managed through the web-based settings page:
- Visit
http://localhost:3000/settings/environment
- Configure your AI provider (Anthropic Claude, OpenAI GPT, Google Gemini, Ollama)
- Set up Jira integration (URL, API token)
- Configure repository provider (Bitbucket)
- Set up issue tracking (Jira, etc.)
All changes are saved to ~/.ai-workflow-utils/environment.json
and persist across upgrades.
No manual .env setup required!
Step 6: (Optional) PWA Installation (Progressive Web App)
AI Workflow Utils is a fully-featured PWA! Install it as a native app for the best experience:
π₯οΈ Desktop Installation:
- Open
http://localhost:3000
in Chrome, Edge - Look for the "Install" button in the address bar
- Click "Install" to add AI Workflow Utils to your desktop
- Launch directly from your desktop/dock - no browser needed!
β¨ PWA Benefits: - π Faster Loading: Cached resources for instant startup - π± Native Feel: Works like a desktop - π Auto Updates: Always get the latest features - πΎ Offline Ready: Basic functionality works without internet - π― Focused Experience: No browser distractions
π― Feature Deep Div
π« AI Jira Ticket Creation
What makes it special:
- Dual AI System: Primary cloud AI with local Ollama fallback
- Image Intelligence: Upload screenshots and get detailed bug reports
- Smart Templates: Automatically formats content based on issue type
- Real-time Generation: Watch AI create your tickets live
Example Usage:
- Navigate to "Create Jira"
- Describe your issue: "Login button doesn't work on mobile"
- Upload a screenshot (optional)
- Select issue type (Bug/Task/Story)
- Watch AI generate professional content
- Review and create ticket directly in Jira
AI Providers Supported:
- OpenAI GPT-4 (with vision)
- Anthropic Claude (with vision)
- Any OpenAI-compatible API
- Ollama LLaVA (local, private)
π AI-Powered Pull Request Creation
Revolutionary PR Generation:
- Smart Commit Analysis: AI analyzes your commit messages to understand the changes
- Automatic Type Detection: Determines if changes are features, fixes, or chores
- Professional Formatting: Generates conventional commit-style titles (feat/fix/chore)
- Streaming Generation: Watch AI create content in real-time with live updates
- Local AI Processing: Uses Ollama for complete privacy and offline capability
How it works:
- Navigate to "Create PR"
- Enter project key, repository slug, ticket number, and branch name
- Click "Preview" to start AI generation
- Watch AI analyze commits and generate title/description in real-time
- Edit the generated content if needed
- Click "Create Pull Request" to submit to Bitbucket
AI Features:
- Commit Message Analysis: Extracts meaningful information from commit history
- Smart Categorization: Automatically prefixes with feat/fix/chore based on content
- Ticket Integration: Includes ticket numbers in standardized format
- Editable Previews: Full control over final content before submission
- Persistent Settings: Remembers project and repo settings for faster workflow
π GitStash PR AI Review
Revolutionary Code Review:
- Context-Aware Analysis: AI understands your codebase
- Security Scanning: Identifies potential vulnerabilities
- Performance Optimization: Suggests efficiency improvements
- Best Practices: Enforces coding standards
How it works:
- Open a pull request in Bitbucket
- Navigate to "GitStash Review"
- Enter PR details
- AI analyzes code changes
- Get detailed review with suggestions
- Coming Soon: Direct comment integration
π Jira Attachment Management
Simplified File Handling:
- Universal Format Support: Images, videos, documents
- Smart Conversion: Automatic .mov to .mp4 for compatibility
- Batch Upload: Multiple files at once
- Preview Integration: View attachments before upload
π οΈ CLI Commands (For Advanced Users)
Setup and Configuration
# Interactive setup wizard
ai-workflow-setup
# Check configuration
ai-workflow-utils --config
# Test connections
ai-workflow-utils --test
Development Commands
# Start in development mode
ai-workflow-utils --dev
# Enable debug logging
ai-workflow-utils --debug
# Specify custom port
ai-workflow-utils --port 8080
Ollama Management
# Check Ollama status
ai-workflow-utils --ollama-status
# Download recommended models
ai-workflow-utils --setup-ollama
# List available models
ollama list
π§ Advanced Configuration (For Developers)
AI Provider Fallback System
// Automatic fallback order:
1. OpenAI Compatible API (Primary)
2. Ollama LLaVA (Local fallback)
3. Error handling with user notification
Custom Model Configuration
# For different OpenAI-compatible providers:
OPENAI_COMPATIBLE_MODEL=gpt-4-vision-preview # OpenAI
OPENAI_COMPATIBLE_MODEL=claude-3-sonnet-20240229 # Anthropic
OPENAI_COMPATIBLE_MODEL=llama-2-70b-chat # Custom API
# For Ollama local models:
OLLAMA_MODEL=llava:13b # Larger model for better quality
OLLAMA_MODEL=llava:7b # Faster, smaller model
OLLAMA_MODEL=codellama:7b # Code-focused model
Performance Tuning
# Streaming configuration
STREAM_CHUNK_SIZE=1024
STREAM_TIMEOUT=60000
# Rate limiting
API_RATE_LIMIT=100
API_RATE_WINDOW=900000
# File upload limits
MAX_FILE_SIZE=50MB
ALLOWED_FILE_TYPES=jpg,jpeg,png,gif,mp4,mov,pdf,doc,docx
π Production Deployment (For DevOps)
Docker Deployment
# Build the application
npm run build
# Create Docker image
docker build -t ai-workflow-utils .
# Run container
docker run -p 3000:3000 --env-file .env ai-workflow-utils
PM2 Process Management
# Install PM2
npm install -g pm2
# Start application
pm2 start ecosystem.config.js
# Monitor
pm2 monit
# View logs
pm2 logs ai-workflow-utils
Nginx Reverse Proxy
server {
listen 80;
server_name your-domain.com;
location / {
proxy_pass http://localhost:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_cache_bypass $http_upgrade;
}
}
π Security & Privacy
Data Privacy
- Local AI Processing: Use Ollama for complete data privacy
- No Data Storage: AI conversations are not stored
- Secure Tokens: Environment-based credential management
- HTTPS Support: SSL/TLS encryption for production
Security Features
- Rate Limiting: Prevents API abuse
- Input Validation: Sanitizes all user inputs
- Error Handling: No sensitive data in error messages
- Access Control: Token-based authentication
π Monitoring & Analytics (For DevOps)
Built-in Monitoring
- Health Checks:
/health
endpoint for monitoring - Performance Metrics: Response times and success rates
- Error Tracking: Comprehensive error logging
- Usage Statistics: AI provider usage analytics
Logging Configuration
# Logging levels: error, warn, info, debug
LOG_LEVEL=info
# Log file rotation
LOG_MAX_SIZE=10MB
LOG_MAX_FILES=5
# Enable request logging
LOG_REQUESTS=true
π€ Contributing (For Developers)
We welcome contributions! Here's how to get started:
Development Setup
# Clone the repository
git clone https://github.com/anuragarwalkar/ai-workflow-utils.git
cd ai-workflow-utils
# Install dependencies
npm install
# Set up environment
cp .env.example .env
cp ui/.env.example ui/.env
# Start development server
npm run dev
Project Structure
ai-workflow-utils/
βββ bin/ # CLI scripts
βββ server/ # Backend (Node.js + Express)
βββ ui/ # Frontend (React + Redux)
βββ dist/ # Built files
βββ docs/ # Documentation
Contribution Guidelines
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
π API Documentation (For Developers)
Core Endpoints
Jira Ticket Creation:
POST /api/jira/preview
Content-Type: application/json
{
"prompt": "Login button not working",
"images": ["base64-encoded-image"],
"issueType": "Bug"
}
Create Pull Request Preview (Streaming):
POST /api/pr/stream-preview
Content-Type: application/json
{
"projectKey": "PROJ",
"repoSlug": "my-repo",
"ticketNumber": "PROJ-123",
"branchName": "feature/my-branch"
}
# Returns Server-Sent Events stream with:
# - status updates
# - title_chunk events (streaming title generation)
# - title_complete event (final title)
# - description_chunk events (streaming description generation)
# - description_complete event (final description)
# - complete event (final preview data)
Create Pull Request:
POST /api/pr/create
Content-Type: application/json
{
"projectKey": "PROJ",
"repoSlug": "my-repo",
"ticketNumber": "PROJ-123",
"branchName": "feature/my-branch",
"customTitle": "feat(PROJ-123): Add user authentication",
"customDescription": "## Summary\nAdded user authentication feature\n\n## Changes Made\n- Added login component\n- Implemented JWT tokens"
}
GitStash PR Review:
POST /api/pr/review
Content-Type: application/json
{
"repoUrl": "https://bitbucket.company.com/projects/PROJ/repos/repo",
"pullRequestId": "123",
"reviewType": "security"
}
File Upload:
POST /api/jira/upload
Content-Type: multipart/form-data
file: [binary-data]
issueKey: "PROJ-123"
π Troubleshooting (For Support)
Common Issues
Ollama Connection Failed:
# Check if Ollama is running
ollama list
# Start Ollama service
ollama serve
# Pull required model
ollama pull llava
Jira Authentication Error:
# Test Jira connection
curl -H "Authorization: Bearer YOUR_TOKEN" \
https://your-company.atlassian.net/rest/api/2/myself
Port Already in Use:
# Use different port
ai-workflow-utils --port 8080
# Or kill existing process
lsof -ti:3000 | xargs kill -9
Debug Mode
# Enable detailed logging
ai-workflow-utils --debug
# Check logs
tail -f logs/app.log
π Support
Getting Help
- π Documentation: GitHub Wiki
- π Bug Reports: GitHub Issues
- π¬ Discussions: GitHub Discussions
- π§ Email: anurag.arwalkar@gmail.com
Community
- β Star us on GitHub: Show your support!
- π Share: Help others discover this tool
- π€ Contribute: Join our growing community
π Roadmap
Coming Soon
- π Direct PR Comments: AI comments directly in Bitbucket
- π Workflow Automation: Custom automation workflows
- π Analytics Dashboard: Usage insights and metrics
- π Plugin System: Extensible architecture
- π Multi-language Support: Internationalization
Future Features
- π€ Advanced AI Agents: Specialized AI for different tasks
- π More Integrations: GitHub, GitLab, Azure DevOps
- π± Mobile App: Native mobile applications
- π― Smart Routing: Intelligent task assignment
π License
This project is licensed under the MIT License - see the LICENSE file for details.
ποΈ Acknowledgments
Special thanks to the amazing open-source community and the following technologies that make this project possible:
- π€ OpenAI & Anthropic: For providing excellent AI APIs
- π Ollama: For enabling local AI processing with privacy
- π― Atlassian: For robust Jira and Bitbucket APIs
- βοΈ React & Redux: For building beautiful, responsive UIs
- π Node.js & Express: For reliable backend infrastructure
- π¨ Material-UI: For professional design components
π Why Choose AI Workflow Utils?
π Productivity Boost
- 10x Faster: Create professional Jira tickets in seconds
- AI-Powered: Let AI handle the heavy lifting
- Streamlined: One tool for all your workflow needs
π Privacy First
- Local Processing: Use Ollama for complete data privacy
- No Vendor Lock-in: Multiple AI provider support
- Your Data: Stays on your infrastructure
π οΈ Developer Friendly
- Easy Setup: Get started in minutes
- CLI Tools: Powerful command-line interface
- Extensible: Open architecture for customization
πΌ Enterprise Ready
- Scalable: Handles teams of any size
- Secure: Enterprise-grade security features
- Reliable: Battle-tested in production environments
π Ready to Transform Your Workflow?
Get Started Today!
npm install -g ai-workflow-utils
β Star us on GitHub if this tool helps you!
π’ Share with your team and boost everyone's productivity!
Made with β€οΈ by Anurag Arwalkar
Empowering developers worldwide with AI-powered workflow automation