Skip to content
Home Assistant BridgeHome Assistant Bridge
Esc
↑↓navigate↵open⌘Jpreview
On this page

ha-bridge homeassistant

Arguments and flags for every ha-bridge homeassistant command.

Every ha-bridge homeassistant command and its help, as --help prints it. Each also accepts the global flags.

ha-bridge homeassistant

DESCRIPTION
  Home Assistant actions

USAGE
  ha-bridge homeassistant <subcommand> [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant turn-on

Alias: ha-bridge homeassistant on

DESCRIPTION
  Turn on entities in any domain

USAGE
  ha-bridge homeassistant turn-on [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, such as light.desk; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge homeassistant turn-off

Alias: ha-bridge homeassistant off

DESCRIPTION
  Turn off entities in any domain

USAGE
  ha-bridge homeassistant turn-off [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, such as light.desk; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge homeassistant toggle

Alias: ha-bridge homeassistant t

DESCRIPTION
  Toggle entities in any domain

USAGE
  ha-bridge homeassistant toggle [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, such as light.desk; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge homeassistant update-entity

DESCRIPTION
  Refresh entities now

USAGE
  ha-bridge homeassistant update-entity [flags] <entity_id...>

ARGUMENTS
  entity_id... string    Full entity ID, such as light.desk; repeat for more

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant restart

DESCRIPTION
  Restart Home Assistant

USAGE
  ha-bridge homeassistant restart [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --safe-mode        Restart in safe mode, without custom integrations

ha-bridge homeassistant stop

DESCRIPTION
  Stop Home Assistant

USAGE
  ha-bridge homeassistant stop [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant check-config

DESCRIPTION
  Check the configuration files

USAGE
  ha-bridge homeassistant check-config [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant reload-core-config

DESCRIPTION
  Reload the core configuration, such as location and customisations

USAGE
  ha-bridge homeassistant reload-core-config [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant reload-custom-templates

DESCRIPTION
  Reload custom Jinja templates

USAGE
  ha-bridge homeassistant reload-custom-templates [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant reload-all

DESCRIPTION
  Reload all YAML configuration

USAGE
  ha-bridge homeassistant reload-all [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant reload-config-entry

DESCRIPTION
  Reload an integration's config entry

USAGE
  ha-bridge homeassistant reload-config-entry [flags] <entry_id>

ARGUMENTS
  entry_id string    Config entry ID

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant save-persistent-states

DESCRIPTION
  Save states that are restored after a restart

USAGE
  ha-bridge homeassistant save-persistent-states [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge homeassistant set-location

DESCRIPTION
  Set the home location

USAGE
  ha-bridge homeassistant set-location [flags] <latitude> <longitude>

ARGUMENTS
  latitude number     Latitude from -90 to 90
  longitude number    Longitude from -180 to 180

FLAGS
  --socket string        Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --elevation integer    Elevation in metres

Last updated on