Skip to content

Velocitytree is tool to streamline workflows by managing project structure, context, and integrating AI assistance.

License

Notifications You must be signed in to change notification settings

gbechtold/Velocitytree

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

64 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Velocitytree 🌳⚑

PyPI version Python Versions License: MIT Tests

🎯 The Problem We Solve

Ever struggled with:

  • Complex project structures becoming unwieldy and hard to navigate?
  • AI assistants lacking project context and generating irrelevant code?
  • Repetitive tasks eating up your valuable development time?
  • Managing multiple workflows across different projects?
  • Documentation that gets out of sync with your codebase?
  • Code drift from original specifications and architecture?
  • Monitoring project health and catching issues early?
  • Predicting project completion accurately?

Velocitytree is your solution! πŸš€

✨ What's New in v2.0

  • πŸ” Continuous Monitoring: Background process that monitors code quality, performance, and drift
  • 🎯 Drift Detection: Automatically detect when code drifts from specifications
  • 🚨 Smart Alerts: Multi-channel alert system with rate limiting and suppression
  • πŸ”§ Realignment Suggestions: AI-powered suggestions to fix detected issues
  • πŸ“ˆ Predictive Analytics: ML-based completion estimates with confidence intervals
  • πŸ€– Claude Integration: Native support for Anthropic's Claude AI
  • 🧠 Smart Documentation: Context-aware documentation generation with quality checks
  • ⚑ Real-time Suggestions: Get code improvements as you work
  • πŸ”„ Workflow Memory: Learn from past decisions and avoid conflicts

πŸš€ Quick Start

# Clone and setup with virtual environment
git clone https://github.com/gbechtold/Velocitytree.git
cd Velocitytree
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .

Initialize your project

vtree init

Start continuous monitoring

vtree monitor background start

Check for drift

vtree monitor drift check

πŸ’‘ Core Features

πŸ” Continuous Monitoring & Evaluation

Monitor your project health in real-time:

# Start background monitoring
vtree monitor background start

# Check monitoring status
vtree monitor background status

# View recent issues
vtree monitor issues

# Configure monitoring
vtree monitor config --enable code --enable performance --interval 300

🎯 Drift Detection

Detect when your code drifts from specifications:

# Check for drift
vtree monitor drift check

# Generate detailed drift report
vtree monitor drift report

# View loaded specifications
vtree monitor drift specs

🚨 Intelligent Alert System

Get notified about critical issues:

# View recent alerts
vtree monitor alerts list

# Test alert system
vtree monitor alerts test --severity warning

# Configure alert channels
vtree monitor alert-config --channel email --channel webhook

πŸ”§ Realignment Suggestions

Get AI-powered suggestions to fix issues:

# Generate suggestions based on drift
vtree monitor realign suggest

# Apply automated fixes
vtree monitor realign apply --suggestion-id <id>

# Export suggestions
vtree monitor realign export --output suggestions.json

πŸ“ˆ Predictive Analytics

Get ML-based completion estimates:

# Predict project completion
vtree progress predict

# Predict feature completion with risks
vtree progress predict --feature user-auth --risks --confidence

# Monitor velocity trends
vtree progress velocity

# Generate burndown chart
vtree progress burndown

πŸ€– Claude AI Integration

Native support for Anthropic's Claude:

# Configure Claude
export CLAUDE_API_KEY=your-key

# Use Claude for analysis
vtree ai analyze --model claude-3

# Get Claude suggestions
vtree analyze --suggestions --model claude

πŸ“˜ Smart Documentation

Generate intelligent documentation:

# Generate comprehensive docs
vtree doc generate --smart

# Incremental documentation updates
vtree doc update --incremental

# Check documentation quality
vtree doc quality --report

⚑ Real-time Suggestions

Get code improvements as you work:

# Start interactive analysis
vtree analyze --interactive

# Get refactoring recommendations
vtree suggestions refactor --file src/main.py

# Get performance optimizations
vtree suggestions performance

🌟 Feature Tree Visualization

Visualize project structure and dependencies:

# Start visual interface
vtree visualize --web

# Generate static visualization
vtree visualize export --format png --layout spring

# Show feature dependencies
vtree visualize deps --feature user-auth

πŸ”„ Natural Language Git Workflow

Manage git with natural language:

# Create feature branch
vtree git feature "Add user authentication"

# Smart commit messages
vtree git commit

# Analyze changes
vtree git analyze

πŸ—£οΈ Conversational Planning

Plan projects through dialogue:

# Start planning session
vtree plan start

# Resume session
vtree plan resume <session-id>

# Export plan
vtree plan export <session-id>

πŸ”Œ Advanced Plugin System

Extend functionality with plugins:

# List plugins
vtree plugin list

# Install plugin
vtree plugin install monitoring-extension

# Create custom plugin
vtree plugin create my-plugin

πŸ“¦ Installation

Prerequisites

  • Python 3.8 or higher
  • Git
  • Virtual environment (recommended)

Standard Installation

pip install velocitytree

Development Installation

git clone https://github.com/gbechtold/Velocitytree.git
cd Velocitytree
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .

Required Dependencies

The following will be installed automatically:

  • Flask & flask-cors (web interface)
  • scikit-learn (predictive analytics)
  • psutil (system monitoring)
  • GitPython (git integration)
  • Rich (beautiful CLI)
  • Click (command framework)
  • And more...

βš™οΈ Configuration

Global Configuration

# ~/.velocitytree/config.yaml
monitoring:
  check_interval: 300
  enable_drift_detection: true
  alert_channels:
    - log
    - email
  
ai:
  default_model: claude-3
  max_tokens: 4000
  
documentation:
  quality_threshold: 0.8
  incremental_updates: true

Project Configuration

# .velocitytree.yaml
project:
  name: MyProject
  version: 2.0.0
  
monitoring:
  enabled: true
  specs:
    - openapi.yaml
    - ARCHITECTURE.md
  
alerts:
  email:
    smtp_host: smtp.gmail.com
    to_emails:
      - team@example.com

πŸ› οΈ Development

Running Tests

# Run all tests
pytest

# Run specific test category
pytest tests/test_monitoring.py

# Run with coverage
pytest --cov=velocitytree

Code Quality

# Run linters
flake8 velocitytree
black velocitytree
mypy velocitytree

# Install pre-commit hooks
pre-commit install

πŸ› Troubleshooting

Common Issues

ModuleNotFoundError: No module named 'flask'

pip install flask flask-cors

ImportError in monitoring module

pip install psutil scikit-learn sqlalchemy

Permission errors

# Always use virtual environment
source venv/bin/activate

Getting Help

  1. Check documentation
  2. Search issues
  3. Join our Discord

🀝 Contributing

We welcome contributions! Please see our Contributing Guide.

Areas for Contribution

  • Additional monitoring metrics
  • New alert channels
  • Improved ML models
  • More language adapters
  • Documentation improvements
  • Bug fixes

πŸ“„ License

MIT License - see LICENSE file for details.

🚧 Roadmap

Version 2.1 (Q2 2024)

  • Cloud monitoring dashboard
  • Team collaboration features
  • Mobile app for alerts
  • More AI model integrations

Version 2.2 (Q3 2024)

  • Distributed monitoring
  • Custom ML model training
  • Advanced security scanning
  • Performance profiling

πŸ™ Acknowledgments


Made with ❀️ by the Velocitytree Team

Star ⭐ this repo if you find it useful!

About

Velocitytree is tool to streamline workflows by managing project structure, context, and integrating AI assistance.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages