Skip to content

Documentation

This documentation is generated from the tagged PersonalClaw release this site publishes, not written alongside it — so it describes the version you can actually install. Every page below is core’s own text, read out of the release commit at build time and published unedited. Nothing here is a second account of the product maintained by the website.

Three routes through it, depending on what you are doing.

Running PersonalClaw. Start with the guides — install, first run, and the specific setups (containers, remote access) people hit first. When you need the exact name of a flag or a config key rather than a walkthrough, that is reference.

Extending PersonalClaw. Architecture is the section for app and provider authors: how the gateway, providers, memory, knowledge, loops and the app platform fit together, and which contracts an app is written against. The app boundary is deliberately narrow, and that section is where the narrowness is explained.

Deciding whether to trust it. Security carries the threat model and a written account of what PersonalClaw does not protect against. It is short and it is meant to be read before you point an autonomous agent at anything you care about.

Research sits apart from the three. It is the corpus the product was designed from rather than documentation of what it does, and its own index says so first.

Two things worth knowing about how this section behaves. Because the site publishes a release rather than a branch, a document written in core after that release has no page here until the next one — so a link in core’s README can work on GitHub and not resolve here, and that asymmetry is the projection rule rather than a broken build. And because every page is generated, an “Edit this page” link goes to core, which is the only place a correction can land.

For the exact commits and tags behind this build, see release provenance. A machine-readable index of everything here is published at /llms.txt, with the full corpus in one file at /llms-full.txt.

  • Guides — The guides walk through running PersonalClaw: installing it, getting a first conversation working, and the specific setups that come up early. (13 pages)
  • Reference — Reference is the exact-surface section: the command-line interface, every configuration key, and the HTTP API the gateway serves. (6 pages)
  • Architecture — Architecture explains how PersonalClaw is put together: the gateway process, the provider boundary, memory and knowledge, loops, tasks and triggers, and the app platform. (17 pages)
  • Security — This section is core’s own security account of PersonalClaw: a threat model that names the trust boundaries the system is designed around, and a written list of what it does not enforce yet. (5 pages)
  • Research — PersonalClaw was designed from a competitive-research corpus before most of it was built, and this section publishes that corpus rather than summarising it. (14 pages)