Documentation
Heddle documentation
If you are setting Heddle up on your site, or running it day to day, start here. Getting started lists what to install and which accounts to create, the install guide takes a site from an empty folder to live, and the command reference covers every command you will type. The agents page explains how far each agent may act before you approve its work, and troubleshooting covers the problems we hit on our own sites.
What is in it
- Getting started: what to install and what to set upThe tools to install, per operating system, and the accounts and keys to create.
- Installing Heddle on a new siteSetting Heddle up on a site, from the heddle/ folder to cutover.
- Command referenceAll 32 commands, with every flag and an example.
- Agents and autonomyThe 16 agents, the autonomy levels, kill switches and the ledger.
- Configuration referenceEvery file in heddle/ and every field in it.
- TroubleshootingProblems we hit, and the fix for each.
The short version
# in the folder that holds your site's repository
git clone <the Heddle repository URL> heddle
(cd heddle && npm ci && npm link)
cd my-site
heddle init .
heddle validate .
heddle launch .
Then fill the heddle/ folder until validate passes, build the site with the generate, aeo and check steps, and work through the launch checklist until nothing is TODO.
Questions
Is Heddle on npm?
No. Heddle is a git repository you clone beside your site and install with npm ci. npm link then puts the heddle command on your path.
Which operating systems does it run on?
Any that runs Node.js 22 or later: macOS, Linux and Windows. The brand kit's image tools are simplest on macOS or Linux, or under WSL on Windows.