Quickstart Tutorial

A short hands-on introduction to HZL.

Prerequisites

• HZL installed (hzl --version)
• HZL initialized (hzl init)

Mode A: Global Queue (inbox)

Use this when you do not need project scoping.

# Add unscoped work (defaults to inbox)
hzl task add "Triage new bugs"
hzl task add "Write daily status summary" --priority 1

# Start a stateless session loop (resume or claim)
hzl workflow run start --agent agent-1 --project inbox

# Record progress and finish
hzl task checkpoint <task-id> "Triage pass complete; 3 bugs prioritized"
hzl task complete <task-id>

Mode B: Project-Scoped Queue (Optional)

Use this when multiple agents share work in one domain.

# Create optional scope
hzl project create research

# Add scoped tasks
hzl task add "Compare retrieval strategies" -P research
hzl task add "Summarize RAG benchmark paper" -P research --priority 2

# Resume-or-claim inside that scope
hzl workflow run start --agent research-agent-1 --project research

# Work and complete
hzl task checkpoint <task-id> "Draft findings prepared"
hzl task complete <task-id>

Optional: Visual Dashboard

hzl serve

Opens at http://localhost:3456 for human visibility.

What to Learn Next

• Concepts — model and guarantees
• Workflows — operating patterns
• CLI Reference — full command details