Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

DMTools Documentation

Welcome to the DMTools documentation! This guide will help you get started with DMTools, understand its features, and integrate it into your workflow.

🎯 Quick Navigation

🚀 Getting Started

Start here if you're new to DMTools:

💻 CLI Usage

Using DMTools from the command line:

⚙️ Jobs (JobRunner)

Automated workflows and jobs:

  • Jobs Overview - Understanding JobRunner and all 20 available jobs

🤖 AI Teammate Workflows

Advanced automation with GitHub Actions:

🔌 Integrations

Connect DMTools to your tools:

🛠️ Configuration

Detailed configuration reference:

📡 API Reference

Programmatic access to DMTools:

👨‍💻 Development

Contributing and building from source:

🚀 Deployment

Production deployment guides:

📚 Popular Pages

For New Users

  1. Installation Guide - Get DMTools running quickly
  2. Configuration Guide - Set up your integrations
  3. First Steps - Learn basic commands
  4. MCP Tools Reference - Explore available tools

For Automation

  1. AI Teammate Overview - Understand the automation workflow
  2. Agent Configuration - Configure your agents
  3. JavaScript Actions - Write custom actions
  4. Jobs Overview - Run automated jobs

For Developers

  1. Architecture - Understand the system design
  2. Building from Source - Set up dev environment
  3. Project Structure - Navigate the codebase
  4. API Reference - Integrate with DMTools

🎓 Learning Path

Beginner Path

  1. Install DMTools → Installation
  2. Configure integrations → Configuration
  3. Try first commands → First Steps
  4. Explore CLI tools → MCP Tools

Automation Path

  1. Understand AI Teammate → Overview
  2. Learn job system → Jobs
  3. Configure agents → Agent Config
  4. Write JavaScript actions → JS Actions

Developer Path

  1. Review architecture → Architecture
  2. Build from source → Building
  3. Understand structure → Structure
  4. Use the API → API Docs

📖 Documentation Structure

docs/
├── README.md                           # You are here
├── INDEX.md                            # Quick file reference
│
├── getting-started/                    # New user guides
│   ├── installation.md
│   ├── configuration.md
│   └── first-steps.md
│
├── cli-usage/                          # CLI reference
│   └── mcp-tools.md
│
├── jobs/                               # JobRunner system
│   └── README.md
│
├── ai-teammate/                        # Automation workflows
│   ├── README.md
│   ├── agent-configuration.md
│   └── javascript-actions.md
│
├── api/                                # API documentation
│   ├── rest-api.md
│   ├── agents-api.md
│   ├── chat-api.md
│   ├── agents-examples.md
│   └── api-reference.md
│
├── integrations/                       # Integration guides
│   └── gemini.md
│
├── development/                        # Developer docs
│   ├── architecture.md
│   ├── building.md
│   ├── project-structure.md
│   ├── project-overview.md
│   ├── dependencies.md
│   ├── commit-rules.md
│   ├── testing-rules.md
│   ├── cursor-setup.md
│   ├── aider-gemini-setup.md
│   └── uri-factory-improvements.md
│
└── deployment/                         # Deployment guides
    ├── production.md
    ├── oauth-setup.md
    └── oauth-proxy.md

💡 Quick Tips

🔑 Essential Commands

# List all available tools
dmtools mcp list

# Get a Jira ticket
dmtools mcp jira_get_ticket '{"key": "PROJ-123"}'

# Search Jira tickets
dmtools mcp jira_search_by_jql '{"searchQueryJQL": "project = PROJ", "fields": ["summary", "status"]}'

# Run a job
dmtools run my-config.json

🎯 Common Use Cases

🔗 External Links

📋 All Documentation Files

See INDEX.md for a complete alphabetical list of all documentation files.

Version: 1.0
Last Updated: 2025-01-05
Status: ✅ Complete and up-to-date