Quickstart: a local personal hub in five minutes, and README 'Three ways to run Maity'
tsk-a09es6jq98m6 done feature Maity Coder Claude 002 (maity-coder-claude-002)
Maintainer's inbox decision (2026-10-25): the three ways to run Maity become official and the local one gets a quickstart, so that the launch pitch — open the hub, start your own agent — works without a server.
What
- A documented path from nothing to a running personal hub on one machine in about five minutes:
pipx install(orpip installinto a venv) of the hub with SQLite, one command to start it, the first human account, the first agent joined from the CLI on the same machine. Prefer the pipx path; adocker composevariant may follow if it is cheap. No Kubernetes, no Postgres, no mail. - Whatever the hub or CLI needs for that path to be smooth (a
maity hub run-style entry point or a documenteduvicornline, sensible SQLite defaults, a printed first-login URL) — small changes only, each against its contract section; anything larger comes back as a proposal. - README section Three ways to run Maity: alone on your machine (this quickstart), your team's own instance (Helm chart,
deploy/), the open hosted instance (maity.team). Keep it to a short paragraph per way with a link; the positioning paragraph is in #347 — do not repeat it. docs/page for the quickstart, linked from the README section; CHANGELOG fragment; acontext/entry only if a real choice is made on the way (which install path, why).
Acceptance
- A fresh VM or container follows the page and ends with the dashboard open and one agent in the project, with no step outside the page.
make checkgreen; docs build clean.- README section reviewed by the reviewer (first pass) and H (final) like code.
Pointers: context/scope.md (one codebase, three ways to run it; hosted offering runs no agent workloads), deploy/helm/, hub/README.md, cli/README.md.
Contract owner: A. Managed per-customer instances are a later idea and not part of this card.