Husky documentation

Husky is a local-first scheduler and workflow runner for repository-owned automation.

Alpha status: Husky is in public alpha. Expect breaking changes before beta, and avoid critical production use until the runtime and packaging story harden further.

This docs site is organized in the same broad style as modern workflow-engine documentation: start with the product model, move into quickstart, then authoring, then runtime operations.

Start here

• What is Husky?
• Installation
• Quickstart
• CLI overview

Documentation sections

Overview

• What is Husky?
• Architecture
• Core concepts

Getting started

• Installation
• Quickstart
• CLI overview

Writing workflows

• Introduction
• YAML reference
• Scheduling
• Dependencies and DAGs
• Retries and concurrency
• Output passing
• Healthchecks and SLAs
• Notifications
• Tags, audit, and timezones

Operations

• Introduction
• Dashboard
• API and WebSockets
• Crash recovery
• Security
• Testing
• Packaging and deployment

What Husky consists of

• cmd/husky/ — user-facing CLI entrypoint
• cmd/huskyd/ — embedded daemon runtime package, invoked through husky daemon run
• internal/config/ — husky.yaml schema, defaults, validation, env interpolation
• internal/daemoncfg/ — huskyd.yaml schema, defaults, validation
• internal/scheduler/ — schedule evaluation and timezone/DST logic
• internal/dag/ — DAG build, cycle detection, topological order
• internal/executor/ — subprocess execution, timeout handling, healthchecks, output capture
• internal/store/ — SQLite persistence layer
• internal/api/ — REST API, WebSocket log streaming, embedded dashboard serving
• internal/ipc/ — local CLI ↔ daemon socket protocol
• internal/notify/ — notification dispatch and alert persistence
• web/ — dashboard source app
• tests/ and cmd/huskyd/*integration*_test.go — integration coverage

Recommended reading order

1. What is Husky?
2. Quickstart
3. YAML reference
4. Scheduling
5. Dependencies and DAGs
6. Operations

Scope note

Documentation in this folder describes the current single-binary Husky runtime and the features surfaced by the repository today. Older planning material in dev-docs/ remains useful background, but this folder is the maintained reference.

Current alpha caveats:

• OIDC auth is not complete yet

• Postgres storage is not complete yet

• metrics, tracing, and secrets backends are not fully wired end to end yet

• service-manager guidance is strongest on macOS and Linux

• background daemon started with husky start

• foreground daemon path husky daemon run

• single shipped husky executable

License

Husky is released under the MIT License.