Command line
# Command line
{/* GENERATED by scripts/gen-reference.ts from the app repo. Do not edit; run `npm run sync`. */}
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](https://github.com/aprajnaparamita/homestead) at commit `5256875` (2026-10-24).
## Synopsis
```text
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
```
## `homestead backup`
Defined in [`server/cmd/homestead/cmd_backup.go`](https://github.com/aprajnaparamita/homestead/blob/main/server/cmd/homestead/cmd_backup.go).
| Flag | Default | Meaning |
| --- | --- | --- |
| `--out` *string* | — | archive to write (FILE.tar.gz) |
## `homestead mcp-stdio`
Defined in [`server/cmd/homestead/cmd_mcp_stdio.go`](https://github.com/aprajnaparamita/homestead/blob/main/server/cmd/homestead/cmd_mcp_stdio.go).
| Flag | Default | Meaning |
| --- | --- | --- |
| `--url` *string* | — | Homestead server origin or /mcp URL |
| `--token` *string* | — | agent token (hst_…) |
## `homestead restore`
Defined in [`server/cmd/homestead/cmd_restore.go`](https://github.com/aprajnaparamita/homestead/blob/main/server/cmd/homestead/cmd_restore.go).
| Flag | Default | Meaning |
| --- | --- | --- |
| `--force` | `false` | replace the Homestead instance already in the data directory |
## `homestead serve`
Defined in [`server/cmd/homestead/cmd_serve.go`](https://github.com/aprajnaparamita/homestead/blob/main/server/cmd/homestead/cmd_serve.go).
| Flag | Default | Meaning |
| --- | --- | --- |
| `--listen` *string* | — | listen address (overrides HOMESTEAD_LISTEN) |
## `homestead token create`
Defined in [`server/cmd/homestead/cmd_token.go`](https://github.com/aprajnaparamita/homestead/blob/main/server/cmd/homestead/cmd_token.go).
| Flag | Default | Meaning |
| --- | --- | --- |
| `--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` *string* | `other` | hermes, openclaw or other |
| `--platforms` *string* | — | comma-separated platform IDs; empty means every agent-tier platform |
## `homestead user reset-password`
Defined in [`server/cmd/homestead/cmd_user.go`](https://github.com/aprajnaparamita/homestead/blob/main/server/cmd/homestead/cmd_user.go).
| Flag | Default | Meaning |
| --- | --- | --- |
| `--password-file` *string* | — | file holding the new password ("-" for stdin); a random one is generated when absent |
## `homestead-helper`
The Homestead Helper is a separate binary for the [Firefox companion](/docs/guides/firefox-companion/)
([`helper/cmd/homestead-helper/main.go`](https://github.com/aprajnaparamita/homestead/blob/main/helper/cmd/homestead-helper/main.go)).
```text
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
```
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).
Synopsis
Section titled “Synopsis”homestead serve # default commandhomestead mcp-stdio --url URL --token T # stdio↔HTTP MCP bridgehomestead backup --out FILE.tar.gz # VACUUM INTO + media folderhomestead restore FILE.tar.gzhomestead user reset-password USERNAMEhomestead token create --name NAME --scopes people:write,ingest:writehomestead backup
Section titled “homestead backup”Defined in server/cmd/homestead/cmd_backup.go.
| Flag | Default | Meaning |
|---|---|---|
--out string | — | archive to write (FILE.tar.gz) |
homestead mcp-stdio
Section titled “homestead mcp-stdio”Defined in server/cmd/homestead/cmd_mcp_stdio.go.
| Flag | Default | Meaning |
|---|---|---|
--url string | — | Homestead server origin or /mcp URL |
--token string | — | agent token (hst_…) |
homestead restore
Section titled “homestead restore”Defined in server/cmd/homestead/cmd_restore.go.
| Flag | Default | Meaning |
|---|---|---|
--force | false | replace the Homestead instance already in the data directory |
homestead serve
Section titled “homestead serve”Defined in server/cmd/homestead/cmd_serve.go.
| Flag | Default | Meaning |
|---|---|---|
--listen string | — | listen address (overrides HOMESTEAD_LISTEN) |
homestead token create
Section titled “homestead token create”Defined in server/cmd/homestead/cmd_token.go.
| Flag | Default | Meaning |
|---|---|---|
--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 string | other | hermes, openclaw or other |
--platforms string | — | comma-separated platform IDs; empty means every agent-tier platform |
homestead user reset-password
Section titled “homestead user reset-password”Defined in server/cmd/homestead/cmd_user.go.
| Flag | Default | Meaning |
|---|---|---|
--password-file string | — | file holding the new password (”-” for stdin); a random one is generated when absent |
homestead-helper
Section titled “homestead-helper”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