Documentation

Dispatch Docs

Operator, reference, and maintainer documentation for the v1 Dispatch command surface. Internal roadmap files remain in the repository but are not public site pages.

Start Here

Use these pages first if you are installing Dispatch or running it for the first time.

Getting StartedShortest path from install to first verified run. InstallationSource install, package install, and ZIP install behavior. Command ReferenceCurrent, planned, and deferred command surfaces. ConceptsJobs, targets, transports, runs, results, logs, and artifacts.

Operators

Day-to-day guides for running scripts, targeting hosts, choosing transports, and reading results.

Running ScriptsPrimary ad-hoc PowerShell workflow. InventoryText inventories, YAML inventories, selectors, and excludes. Inventory SchemaSupported YAML inventory sections and precedence. TransportsTransport overview and selection guide. PsExec TransportRequirements, behavior, and common failures. Raw WinRM TransportListener requirements and validation commands. PSRP TransportRemoting requirements, streams, and credentials. ConfigurationGlobal YAML config, precedence, and defaults. Output And ResultsRun folders, events, summaries, stdout/stderr. LogsDurable run history and logs commands. TroubleshootingResolution, inventory, transport, config, and artifact failures. SecurityNo plaintext secrets, redaction, and endpoint policy. Script-Owned PayloadsWhat Dispatch stages and what scripts own.

Reference

Stable contracts for automation, configuration, credentials, schemas, and examples.

Docs HomePrimary documentation entry point. CredentialsCredential references, providers, and enrollment behavior. Error CodesCLI exit codes and target failure categories. Result SchemaMachine-readable run and target result contract. ExamplesCopy/paste examples for common operations. FAQShort answers to common questions. JobsDeclared job operator guide. Job SchemaExact YAML job contract.

Maintainers

Project structure, validation policy, release planning, and deferred feature documents.

ArchitectureProject layout and dependency boundaries. DevelopmentBuild, test, validation, and contribution workflow. Testing And ValidationAutomated and live validation policy. Roadmap StatusWhat works, what is partial, and what is planned. PowerShell ModuleWrapper surface and PSCredential handoff model. DistributionSource installer, ZIP, and local package guidance. Managed ExecutionDeferred managed execution mode. Enterprise DistributionDeferred enterprise package channels.