Skip to content

CLI

The Go Automate CLI groups its commands by area. Most live under the home-assistant command (aliased ha), with notify and tui available at the top level. Every command group has short aliases so you can bind them to keyboard shortcuts comfortably.

CommandAliasPurpose
home-assistanthaControl Home Assistant and watch entities.
notifynSend a desktop notification.
tuiLaunch the interactive terminal menu.

For the full command tree with every flag, see the Commands reference.

The ha command controls entities and watches their state:

Terminal window
# Toggle a light entity (light.bedroom_lamp)
go-automate ha light toggle bedroom_lamp
# Turn a switch on
go-automate ha switch turn-on desk_fan
# Announce to an area through an assist satellite
go-automate ha assist_satellite announce living_room "Dinner is ready"

See Home Assistant for the full set of control commands, and Watching Entities for live state.

Send a desktop notification through notify-send:

Terminal window
go-automate notify "Build complete" "Your build finished successfully"

See Notifications for the details.

Running Go Automate with no command in an interactive terminal launches the TUI automatically when the go-automate-tui binary is available. You can also launch it explicitly:

Terminal window
go-automate tui

If you are not in an interactive terminal, or the TUI binary is not found, Go Automate continues in CLI mode.

  • Use the short aliases for shortcuts, for example go-automate ha l toggle bedroom_lamp.
  • Entity commands take the entity name without its domain prefix. go-automate ha light turn-on bedroom_lamp acts on light.bedroom_lamp.
  • Wrap multi-word arguments in quotes, for example announce messages.