Skip to content

Command line

The server is one binary, homestead. In Docker, run commands inside the container, for example docker exec -it homestead homestead backup --out /data/backup.tar.gz. Generated from the app repository at commit 5256875 (2026-10-24).

homestead serve # default command
homestead mcp-stdio --url URL --token T # stdio↔HTTP MCP bridge
homestead backup --out FILE.tar.gz # VACUUM INTO + media folder
homestead restore FILE.tar.gz
homestead user reset-password USERNAME
homestead token create --name NAME --scopes people:write,ingest:write

Defined in server/cmd/homestead/cmd_backup.go.

FlagDefaultMeaning
--out string—archive to write (FILE.tar.gz)

Defined in server/cmd/homestead/cmd_mcp_stdio.go.

FlagDefaultMeaning
--url string—Homestead server origin or /mcp URL
--token string—agent token (hst_…)

Defined in server/cmd/homestead/cmd_restore.go.

FlagDefaultMeaning
--forcefalsereplace the Homestead instance already in the data directory

Defined in server/cmd/homestead/cmd_serve.go.

FlagDefaultMeaning
--listen string—listen address (overrides HOMESTEAD_LISTEN)

Defined in server/cmd/homestead/cmd_token.go.

FlagDefaultMeaning
--name string—name for the token, shown in the app
--scopes string—comma-separated scopes, for example people:write,ingest:write; overrides —preset
--preset string—fetcher, helper or full (default: helper)
--agent-kind stringotherhermes, openclaw or other
--platforms string—comma-separated platform IDs; empty means every agent-tier platform

Defined in server/cmd/homestead/cmd_user.go.

FlagDefaultMeaning
--password-file string—file holding the new password (”-” for stdin); a random one is generated when absent

The Homestead Helper is a separate binary for the Firefox companion (helper/cmd/homestead-helper/main.go).

usage: homestead-helper <command> [flags]
commands:
install --server URL register with Firefox and pin the server origin
uninstall remove the registration
status show what is registered and where
run serve the native-messaging channel (default)
version print the helper version