Household / Docs GitHub

Getting started

Household overview

Household runs assistant bots with coding harnesses such as Claude Code or Codex. Talk to each bot in a messenger, with its own VM, network access and credentials under your control.

A daemon, house, runs on your Mac or Linux machine. It starts each bot in its own microVM, connects it to a messenger (e.g. Telegram) and stands between the bot and the internet. Each bot answers in its own thread and keeps its files and memory between conversations.

Core concepts

ConceptDescription
WorkspaceA group of bots sharing an allowlist, secrets, channels and owners.
ChannelA workspace's connection to a messenger, e.g. a Telegram bot.
BotAn assistant running in a workspace: its own VM with a persistent home and memory, and its own chat thread.
HarnessWhat a bot runs on: a coding runtime, e.g. the Claude Code CLI or the Codex CLI.
SideworkerA temporary clone of a bot for a separate task in another directory. Same workspace, same permissions.
ScoutA one-task VM for access a bot doesn't have or for untrusted sites. Runs only with your approval and reports to you, never to the bot.

How it works

  1. Install the daemon

    house, on your Mac or Linux machine.

  2. Create a workspace

    Choose which hosts its bots may reach and which secrets they may use.

  3. Connect a messenger

    E.g. a Telegram bot.

  4. Add a bot

    Pick its harness, e.g. the Claude Code CLI, and set up its VM: a setup script installs the tools and packages it needs.

  5. Talk to it

    Write in its thread. It replies there, calling scouts or starting sideworkers when needed.

house onboard walks you through steps 2 to 4 in the terminal.

Network and secrets

All of a bot's traffic goes through the daemon:

Substitution happens at egress, not inside the VM, so it works only for HTTP(S) clients that send the secret verbatim in a header. Database passwords, SSH keys, request signatures (e.g. AWS SigV4) and anything read from a file need the real value in the VM.

Where it runs

PartSupported
MachinemacOS on Apple silicon, or Linux with KVM (your own machine, a VM with nested virtualization, or a KVM-enabled VPS)
HarnessesClaude Code CLI, Codex CLI
MessengersTelegram (bot, threaded mode)

Next steps