dave
136 lines
6.4 KiB
HTML
136 lines
6.4 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>Documentation — Huskies</title>
|
|
<meta name="description" content="Huskies documentation: quickstart, configuration, bot commands, pipeline, and more.">
|
|
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link href="https://fonts.googleapis.com/css2?family=Bricolage+Grotesque:wght@400;500;600;700;800&family=Karla:ital,wght@0,300;0,400;0,500;1,300;1,400&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="docs.css">
|
|
</head>
|
|
<body>
|
|
|
|
<div class="shell">
|
|
<header class="reveal r1">
|
|
<a href="/" class="logo">huskies</a>
|
|
<nav>
|
|
<a href="/#how">How it works</a>
|
|
<a href="/#features">Features</a>
|
|
<a href="/docs/" class="active">Docs</a>
|
|
<a href="https://code.crashlabs.io/crashlabs/huskies">Source</a>
|
|
<a href="https://code.crashlabs.io/crashlabs/huskies/releases">Releases</a>
|
|
<a href="mailto:hello@huskies.dev" class="nav-cta">Get in touch</a>
|
|
</nav>
|
|
</header>
|
|
</div>
|
|
|
|
<div class="shell">
|
|
<div class="docs-layout">
|
|
<aside class="sidebar reveal r2">
|
|
<div class="sidebar-section">
|
|
<div class="sidebar-heading">Getting started</div>
|
|
<nav>
|
|
<a href="/docs/" class="active">Overview</a>
|
|
<a href="quickstart.html">Quickstart</a>
|
|
</nav>
|
|
</div>
|
|
<div class="sidebar-section">
|
|
<div class="sidebar-heading">Reference</div>
|
|
<nav>
|
|
<a href="configuration.html">Configuration</a>
|
|
<a href="commands.html">Bot commands</a>
|
|
<a href="cli.html">CLI</a>
|
|
</nav>
|
|
</div>
|
|
<div class="sidebar-section">
|
|
<div class="sidebar-heading">Guides</div>
|
|
<nav>
|
|
<a href="pipeline.html">Pipeline stages</a>
|
|
<a href="transports.html">Chat transports</a>
|
|
</nav>
|
|
</div>
|
|
</aside>
|
|
|
|
<main class="docs-main reveal r3">
|
|
<p class="hero-kicker" style="font-family:var(--display);font-size:0.68rem;font-weight:600;letter-spacing:0.18em;text-transform:uppercase;color:var(--cyan);margin-bottom:1rem;">Documentation</p>
|
|
<h1 class="page-title">Huskies Docs</h1>
|
|
<p class="page-subtitle">Everything you need to set up and run huskies — a story-driven development pipeline that turns coding agents into a disciplined team.</p>
|
|
|
|
<div class="doc-cards">
|
|
<a class="doc-card" href="quickstart.html">
|
|
<div class="doc-card-title">Quickstart</div>
|
|
<div class="doc-card-desc">Install huskies, run the server, create your first story, and watch an agent implement it.</div>
|
|
</a>
|
|
<a class="doc-card" href="configuration.html">
|
|
<div class="doc-card-title">Configuration</div>
|
|
<div class="doc-card-desc">Reference for <code>project.toml</code>, <code>agents.toml</code>, and <code>bot.toml</code>.</div>
|
|
</a>
|
|
<a class="doc-card" href="commands.html">
|
|
<div class="doc-card-title">Bot commands</div>
|
|
<div class="doc-card-desc">Full list of commands available in Matrix, Slack, WhatsApp, and the web UI.</div>
|
|
</a>
|
|
<a class="doc-card" href="pipeline.html">
|
|
<div class="doc-card-title">Pipeline stages</div>
|
|
<div class="doc-card-desc">How work items move from backlog through QA and merge to done.</div>
|
|
</a>
|
|
<a class="doc-card" href="transports.html">
|
|
<div class="doc-card-title">Chat transports</div>
|
|
<div class="doc-card-desc">Connect huskies to Matrix, WhatsApp, Slack, Discord, or the built-in web UI.</div>
|
|
</a>
|
|
<a class="doc-card" href="cli.html">
|
|
<div class="doc-card-title">CLI reference</div>
|
|
<div class="doc-card-desc">Command-line flags for <code>huskies</code>, <code>huskies init</code>, and <code>huskies agent</code>.</div>
|
|
</a>
|
|
</div>
|
|
|
|
<h2>What is huskies?</h2>
|
|
<p>Huskies is a story-driven development server. You write stories (feature requests) with acceptance criteria; huskies spawns coding agents in isolated git worktrees, runs them through quality gates, and squash-merges the result to your main branch — all without you writing a line of code.</p>
|
|
<p>It ships as a single Rust binary with an embedded React frontend. No separate database or build infrastructure required.</p>
|
|
|
|
<h2>How it works</h2>
|
|
<ol class="step-list">
|
|
<li>
|
|
<div>
|
|
<strong>Write a story.</strong> Describe the change with acceptance criteria via the web UI, a chat room (Matrix, WhatsApp, Slack), or by dropping a Markdown file in <code>.huskies/work/1_backlog/</code>.
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<div>
|
|
<strong>Agent picks it up.</strong> Run <code>start <number></code> (or configure auto-start). A coder agent creates a feature branch, implements the code, and writes tests against your criteria.
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<div>
|
|
<strong>Quality gates run.</strong> Linters, tests, and compilation checks run automatically when the agent exits. Nothing moves forward until everything passes.
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<div>
|
|
<strong>QA review.</strong> A QA agent verifies each acceptance criterion, runs your test suite, and either approves or rejects with detailed findings.
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<div>
|
|
<strong>Merge & land.</strong> A merge agent resolves conflicts and squash-merges to your main branch. The worktree is cleaned up automatically.
|
|
</div>
|
|
</li>
|
|
</ol>
|
|
|
|
<h2>Key concepts</h2>
|
|
<p><strong>Stories</strong> are Markdown files with YAML front matter. They live in <code>.huskies/work/</code> and move through pipeline stages as work progresses.</p>
|
|
<p><strong>Agents</strong> are Claude Code sessions that run autonomously in git worktrees. Each story gets its own isolated worktree so multiple stories can be in flight simultaneously.</p>
|
|
<p><strong>MCP tools</strong> give Claude Code sessions programmatic access to the pipeline: creating stories, starting agents, checking status, recording test results.</p>
|
|
</main>
|
|
</div>
|
|
|
|
<footer class="reveal r3">
|
|
<span>© 2026 Libby Labs Ltd.</span>
|
|
<a href="/privacy.html">Privacy Policy</a>
|
|
</footer>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|