Dispatch Documentation

Dispatch is a Windows-native endpoint automation runner for administrators who need to run scripts, commands, and declared YAML jobs across Windows hosts with durable results and explicit transport behavior.

Dispatch is not an endpoint agent, package manager, or full configuration-management platform. It focuses on target selection, execution planning, transport execution, credential references, live status, logs, results, and copied-back script-created files.

Endpoint credentials and script secret handoff are separate models. --credential <name> selects the remoting credential. The script input surface is dispatch run ps ... --secret name=reference; current support validates the option shape and renders only a redacted binding such as -packageSas [redacted] in plan/dry-run output. Runtime provider resolution and safe transport parameter binding are planned Roadmap 10 work.

Start Here

• Getting Started - first install, validation, and run.
• Installation - primary install, direct dispatch invocation, module autoloading, source execution, and local package install behavior.
• Concepts - jobs, targets, inventories, transports, plans, runs, results, logs, and artifacts.
• Command Reference - command tree, options, examples, and implementation status.
• Running Scripts - day-to-day dispatch run ps workflows.

Operator Guides

• Inventory
• Inventory Schema
• Transports
• PsExec Transport
• Raw WinRM Transport
• PSRP Transport
• Configuration
• Output And Results
• Logs
• Troubleshooting
• Security
• Script-Owned Payloads

Contracts And References

• Credentials
• Error Codes
• Result Schema
• Examples
• FAQ
• Jobs
• Job Schema

Maintainer Guides

• Architecture
• Development
• Testing And Validation
• Roadmap Status
• PowerShell Module
• Distribution

Deferred Feature Docs

• Managed Execution
• Enterprise Distribution

Internal roadmap and documentation inventory files remain in the repository for maintainers, but they are not first-class public site pages.