CLI Reference
A terminal UI for tracking everything about your home.
micasa#
A terminal UI for tracking everything about your home.
Usage#
micasa [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for micasa |
--print-path | - | Print the resolved database path and exit |
-v, --version | - | version for micasa |
Subcommands#
micasa backup#
Back up the database to a file.
Usage#
micasa backup [destination] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for backup |
--source | - | Source database path (default: standard location, honors MICASA_DB_PATH) |
See also#
micasa – A terminal UI for tracking everything about your home
micasa config#
Manage application configuration.
Usage#
micasa config [filter] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for config |
Subcommands#
See also#
micasa – A terminal UI for tracking everything about your home
micasa config edit#
Open the config file in an editor.
Usage#
micasa config edit [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for edit |
See also#
micasa config get#
Query config values with a jq filter (default: identity).
Usage#
micasa config get [filter] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for get |
See also#
micasa demo#
Launch with fictitious sample data. Without a path argument, uses an in-memory database.
Usage#
micasa demo [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for demo |
--seed-only | - | Seed data and exit without launching the TUI |
--years | 0 | Generate N years of simulated home ownership data |
See also#
micasa – A terminal UI for tracking everything about your home
micasa mcp#
Start a Model Context Protocol server over stdio, exposing micasa data to LLM clients like Claude Desktop and Claude Code.
Usage#
micasa mcp [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for mcp |
See also#
micasa – A terminal UI for tracking everything about your home
micasa pro#
Encrypted multi-device sync for your household data.
Typical workflow:
- First device: micasa pro init
- First device: micasa pro invite (prints a one-time code)
- Second device: micasa pro join <code>
- Either device: micasa pro sync (push and pull changes)
Examples#
micasa pro init
micasa pro invite
micasa pro join 01JQ7X2K.abc123
micasa pro sync
micasa pro status
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for pro |
Subcommands#
See also#
micasa – A terminal UI for tracking everything about your home
micasa pro conflicts#
List sync ops that lost LWW conflict resolution.
Usage#
micasa pro conflicts [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for conflicts |
See also#
micasa pro devices#
List devices.
Usage#
micasa pro devices [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for devices |
Subcommands#
See also#
micasa pro devices revoke#
Revoke a device.
Usage#
micasa pro devices revoke <device-id> [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for revoke |
See also#
micasa pro init#
Bootstrap: create household, generate keys, register device.
Usage#
micasa pro init [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for init |
--relay-url | https://relay.micasa.dev | Relay server URL (honors MICASA_RELAY_URL) |
See also#
micasa pro invite#
Generate invite code, wait for joiner handshake.
Usage#
micasa pro invite [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for invite |
See also#
micasa pro join#
Join household with invite code.
Usage#
micasa pro join <code> [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for join |
--relay-url | https://relay.micasa.dev | Relay server URL (honors MICASA_RELAY_URL) |
See also#
micasa pro status#
Show sync status.
Usage#
micasa pro status [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for status |
See also#
micasa pro storage#
Show blob storage usage.
Usage#
micasa pro storage [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for storage |
See also#
micasa pro sync#
Force immediate push+pull cycle.
Usage#
micasa pro sync [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for sync |
See also#
micasa query#
Execute a validated SELECT query against the database.
Only SELECT/WITH statements are allowed. Results are capped at 200 rows
with a 10-second timeout.
Usage#
micasa query <sql> [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for query |
--json | - | Output as JSON |
See also#
micasa – A terminal UI for tracking everything about your home
micasa show#
Print entity data to stdout. Entities: house, projects, project-types,
quotes, vendors, maintenance, maintenance-categories, service-log,
appliances, incidents, documents, all.
Flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
-h, --help | - | help for show |
--json | - | Output as JSON |
Subcommands#
See also#
micasa – A terminal UI for tracking everything about your home
micasa show all#
Show all entities.
Usage#
micasa show all [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for all |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show appliances#
Show appliances.
Usage#
micasa show appliances [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for appliances |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show documents#
Show documents.
Usage#
micasa show documents [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for documents |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show house#
Show house profile.
Usage#
micasa show house [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for house |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show incidents#
Show incidents.
Usage#
micasa show incidents [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for incidents |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show maintenance#
Show maintenance items.
Usage#
micasa show maintenance [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for maintenance |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show maintenance-categories#
Show maintenance categories.
Usage#
micasa show maintenance-categories [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for maintenance-categories |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show project-types#
Show project types.
Usage#
micasa show project-types [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for project-types |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show projects#
Show projects.
Usage#
micasa show projects [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for projects |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show quotes#
Show quotes.
Usage#
micasa show quotes [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for quotes |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show service-log#
Show service log entries.
Usage#
micasa show service-log [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for service-log |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#
micasa show vendors#
Show vendors.
Usage#
micasa show vendors [database-path] [flags]
Flags#
| Flag | Default | Description |
|---|
-h, --help | - | help for vendors |
Inherited flags#
| Flag | Default | Description |
|---|
--deleted | - | Include soft-deleted rows |
--json | - | Output as JSON |
See also#