micasa

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#

FlagDefaultDescription
-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#

FlagDefaultDescription
-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#

FlagDefaultDescription
-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#

FlagDefaultDescription
-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#

FlagDefaultDescription
-h, --help-help for get

See also#

micasa db#

Read and write entity data.

Flags#

FlagDefaultDescription
-h, --help-help for db

Subcommands#

See also#

  • micasa – A terminal UI for tracking everything about your home

micasa db appliance#

Manage appliances.

Flags#

FlagDefaultDescription
-h, --help-help for appliance

Subcommands#

See also#

micasa db appliance add#

Add a appliance.

Usage#

micasa db appliance add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db appliance delete#

Delete a appliance.

Usage#

micasa db appliance delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db appliance edit#

Edit a appliance.

Usage#

micasa db appliance edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db appliance get#

Get a appliance by ID.

Usage#

micasa db appliance get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db appliance list#

List appliances.

Usage#

micasa db appliance list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db appliance restore#

Restore a deleted appliance.

Usage#

micasa db appliance restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

See also#

micasa db chat#

View and manage chat history.

Flags#

FlagDefaultDescription
-h, --help-help for chat

Subcommands#

See also#

micasa db chat delete#

Delete a chat history entry.

Usage#

micasa db chat delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db chat list#

List chat history.

Usage#

micasa db chat list [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for list
--table-Output as table

See also#

micasa db deletion#

View deletion audit records.

Flags#

FlagDefaultDescription
-h, --help-help for deletion

Subcommands#

See also#

micasa db deletion list#

List deletion records.

Usage#

micasa db deletion list [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for list
--table-Output as table

See also#

micasa db document#

Manage documents.

Flags#

FlagDefaultDescription
-h, --help-help for document

Subcommands#

See also#

micasa db document add#

Add a document.

Usage#

micasa db document add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
--file-Path to file to upload
-h, --help-help for add

See also#

micasa db document delete#

Delete a document.

Usage#

micasa db document delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db document edit#

Edit a document.

Usage#

micasa db document edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db document get#

Get a document by ID.

Usage#

micasa db document get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db document list#

List documents.

Usage#

micasa db document list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db document restore#

Restore a deleted document.

Usage#

micasa db document restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

See also#

micasa db house#

Manage house profile.

Flags#

FlagDefaultDescription
-h, --help-help for house

Subcommands#

See also#

micasa db house add#

Add house profile.

Usage#

micasa db house add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db house edit#

Edit house profile.

Usage#

micasa db house edit [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db house get#

Get house profile.

Usage#

micasa db house get [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get

See also#

micasa db incident#

Manage incidents.

Flags#

FlagDefaultDescription
-h, --help-help for incident

Subcommands#

See also#

micasa db incident add#

Add a incident.

Usage#

micasa db incident add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db incident delete#

Delete a incident.

Usage#

micasa db incident delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db incident edit#

Edit a incident.

Usage#

micasa db incident edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db incident get#

Get a incident by ID.

Usage#

micasa db incident get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db incident list#

List incidents.

Usage#

micasa db incident list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db incident restore#

Restore a deleted incident.

Usage#

micasa db incident restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

See also#

micasa db maintenance#

Manage maintenance items.

Flags#

FlagDefaultDescription
-h, --help-help for maintenance

Subcommands#

See also#

micasa db maintenance add#

Add a maintenance item.

Usage#

micasa db maintenance add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db maintenance delete#

Delete a maintenance item.

Usage#

micasa db maintenance delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db maintenance edit#

Edit a maintenance item.

Usage#

micasa db maintenance edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db maintenance get#

Get a maintenance item by ID.

Usage#

micasa db maintenance get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db maintenance list#

List maintenance items.

Usage#

micasa db maintenance list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db maintenance restore#

Restore a deleted maintenance item.

Usage#

micasa db maintenance restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

See also#

micasa db maintenance-category#

Manage maintenance categorys.

Flags#

FlagDefaultDescription
-h, --help-help for maintenance-category

Subcommands#

See also#

micasa db maintenance-category list#

List maintenance categorys.

Usage#

micasa db maintenance-category list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db project#

Manage projects.

Flags#

FlagDefaultDescription
-h, --help-help for project

Subcommands#

See also#

micasa db project add#

Add a project.

Usage#

micasa db project add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db project delete#

Delete a project.

Usage#

micasa db project delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db project edit#

Edit a project.

Usage#

micasa db project edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db project get#

Get a project by ID.

Usage#

micasa db project get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db project list#

List projects.

Usage#

micasa db project list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db project restore#

Restore a deleted project.

Usage#

micasa db project restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

See also#

micasa db project-type#

Manage project types.

Flags#

FlagDefaultDescription
-h, --help-help for project-type

Subcommands#

See also#

micasa db project-type list#

List project types.

Usage#

micasa db project-type list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db quote#

Manage quotes.

Flags#

FlagDefaultDescription
-h, --help-help for quote

Subcommands#

See also#

micasa db quote add#

Add a quote.

Usage#

micasa db quote add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db quote delete#

Delete a quote.

Usage#

micasa db quote delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db quote edit#

Edit a quote.

Usage#

micasa db quote edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db quote get#

Get a quote by ID.

Usage#

micasa db quote get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db quote list#

List quotes.

Usage#

micasa db quote list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db quote restore#

Restore a deleted quote.

Usage#

micasa db quote restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

See also#

micasa db service-log#

Manage service log entrys.

Flags#

FlagDefaultDescription
-h, --help-help for service-log

Subcommands#

See also#

micasa db service-log add#

Add a service log entry.

Usage#

micasa db service-log add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db service-log delete#

Delete a service log entry.

Usage#

micasa db service-log delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db service-log edit#

Edit a service log entry.

Usage#

micasa db service-log edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db service-log get#

Get a service log entry by ID.

Usage#

micasa db service-log get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db service-log list#

List service log entrys.

Usage#

micasa db service-log list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db service-log restore#

Restore a deleted service log entry.

Usage#

micasa db service-log restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

See also#

micasa db vendor#

Manage vendors.

Flags#

FlagDefaultDescription
-h, --help-help for vendor

Subcommands#

See also#

micasa db vendor add#

Add a vendor.

Usage#

micasa db vendor add [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with field values
--data-file-Path to JSON file with field values
-h, --help-help for add

See also#

micasa db vendor delete#

Delete a vendor.

Usage#

micasa db vendor delete <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for delete

See also#

micasa db vendor edit#

Edit a vendor.

Usage#

micasa db vendor edit <id> [database-path] [flags]

Flags#

FlagDefaultDescription
--data-JSON object with fields to update
--data-file-Path to JSON file with fields to update
-h, --help-help for edit

See also#

micasa db vendor get#

Get a vendor by ID.

Usage#

micasa db vendor get <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for get
--table-Output as table

See also#

micasa db vendor list#

List vendors.

Usage#

micasa db vendor list [database-path] [flags]

Flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
-h, --help-help for list
--table-Output as table

See also#

micasa db vendor restore#

Restore a deleted vendor.

Usage#

micasa db vendor restore <id> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for restore

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#

FlagDefaultDescription
-h, --help-help for demo
--seed-only-Seed data and exit without launching the TUI
--years0Generate 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#

FlagDefaultDescription
-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:

  1. First device: micasa pro init
  2. First device: micasa pro invite (prints a one-time code)
  3. Second device: micasa pro join <code>
  4. 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#

FlagDefaultDescription
-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#

FlagDefaultDescription
-h, --help-help for conflicts

See also#

micasa pro devices#

List devices.

Usage#

micasa pro devices [database-path] [flags]

Flags#

FlagDefaultDescription
-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#

FlagDefaultDescription
-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#

FlagDefaultDescription
-h, --help-help for init
--relay-urlhttps://relay.micasa.devRelay 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#

FlagDefaultDescription
-h, --help-help for invite

See also#

micasa pro join#

Join household with invite code.

Usage#

micasa pro join <code> [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for join
--relay-urlhttps://relay.micasa.devRelay server URL (honors MICASA_RELAY_URL)

See also#

micasa pro status#

Show sync status.

Usage#

micasa pro status [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for status

See also#

micasa pro storage#

Show blob storage usage.

Usage#

micasa pro storage [database-path] [flags]

Flags#

FlagDefaultDescription
-h, --help-help for storage

See also#

micasa pro sync#

Force immediate push+pull cycle.

Usage#

micasa pro sync [database-path] [flags]

Flags#

FlagDefaultDescription
-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#

FlagDefaultDescription
-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#

FlagDefaultDescription
--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#

FlagDefaultDescription
-h, --help-help for all

Inherited flags#

FlagDefaultDescription
--deleted-Include soft-deleted rows
--json-Output as JSON

See also#

micasa status#

Print items that need attention and exit with code 2 if any are found. Exit 0 means everything is on track. Useful for cron jobs, shell prompts, and status bar widgets.

Usage#

micasa status [database-path] [flags]

Flags#

FlagDefaultDescription
--days30Look-ahead window for upcoming items (1-365)
-h, --help-help for status
--json-Output JSON instead of human-readable text

See also#

  • micasa – A terminal UI for tracking everything about your home