Skip to content

user-guide.md

Latest commit

 

History

History
156 lines (122 loc) · 5.34 KB

user-guide.md

File metadata and controls

156 lines (122 loc) · 5.34 KB
Raw

Task Orchestrator User Guide

Welcome to Task Orchestrator - the tool that transforms meta-agents into orchestration engines.

Use Task Orchestrator inside your own project repository.
Cloning T72/task-orchestrator is only required when contributing to Task Orchestrator itself.

📚 Documentation Structure

Quick Navigation

Guide Purpose Time to Read
Getting Started Installation and first tasks 5 minutes
Core Features Essential capabilities 15 minutes
Advanced Usage Complex workflows 20 minutes

By User Type

🚀 New Users

  1. Start with Getting Started
  2. Learn Core Features
  3. Try the QuickStart Guide

👨‍💻 Developers

  1. Review Core Features
  2. Master Advanced Usage
  3. Read Developer Guide
  4. Check API Reference

🤖 AI Agent Builders

  1. Read AI Agent Integration
  2. Study Orchestrator Guide
  3. Implement Task Delegation Framework

🔧 System Administrators

  1. Follow Deployment Guide
  2. Configure using Advanced Usage
  3. Monitor with Troubleshooting Guide

Key Concepts

What is Task Orchestrator?

Task Orchestrator is a lightweight, zero-dependency tool that enables AI agents to coordinate complex workflows with:

  • 95%+ completion rates through intelligent dependency management
  • 4-5x speed improvements via parallel execution
  • <5% rework using Commander's Intent framework

Core Principles

  1. Commander's Intent: Every task has WHY/WHAT/DONE
  2. Shared Context: Agents share discoveries and insights
  3. Automatic Unblocking: Dependencies resolve instantly
  4. Real-Time Awareness: Watch mode enables immediate reactions

Feature Overview

Essential Features

  • ✅ Task creation and management
  • ✅ Dependency chains and resolution
  • ✅ Multi-agent assignment
  • ✅ Progress tracking
  • ✅ Real-time notifications

Advanced Capabilities

  • ✅ Template system
  • ✅ Bulk operations
  • ✅ Custom workflows
  • ✅ Performance analytics
  • ✅ CI/CD integration

Enterprise Features

  • ✅ Orchestration enforcement
  • ✅ Configurable policies
  • ✅ Audit trails
  • ✅ Team metrics
  • ✅ Custom reporting

Learning Path

Week 1: Fundamentals

Week 2: Advanced Skills

Week 3: Mastery

  • Day 1-2: Custom automation scripts
  • Day 3-4: Performance optimization
  • Day 5: Team rollout and training

Support Resources

Documentation

  • Guides: Step-by-step instructions
  • Reference: Technical specifications
  • Examples: Real-world scenarios
  • Troubleshooting: Common issues and solutions

Getting Help

  • Quick Help: Run ./tm --help
  • Command Help: Run ./tm COMMAND --help
  • Troubleshooting: See Troubleshooting Guide
  • Issues: Report via docs/support/templates/issue.md
  • Features: Request via docs/support/templates/feedback.md

Version Information

  • Current Version: 2.9.0
  • Released: February 28, 2026
  • Highlights: Governance hardening, release-manager chaining, and boundary validation updates
  • Migration: See Migration Guide

Quick Reference Card

Most Used Commands

./tm init                    # Initialize
./tm add "task"             # Create task
./tm list                   # View tasks
./tm show ID                # Task details
./tm update ID --status X   # Update status
./tm complete ID            # Mark complete
./tm watch                  # Monitor changes

Power User Commands

./tm add "task" --context "WHY: X WHAT: Y DONE: Z"  # Commander's Intent
./tm add "task" --depends-on ID                     # Dependencies
./tm add "task" --assignee agent                    # Assignment
./tm share ID "message"                             # Share context
./tm critical-path                                  # Find bottlenecks
./tm metrics --completion-rate                      # Analytics

Philosophy

Task Orchestrator follows these principles:

  • LEAN: Eliminate waste, maximize value
  • KISS: Keep it simple and straightforward
  • Zero Dependencies: Python stdlib only
  • Local First: Your data stays on your machine
  • Tool Agnostic: Works with any AI system

Community

Choose your path: Get Started | Learn Features | Go Advanced