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

ha-bridge tts

Arguments and flags for every ha-bridge tts command.

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

ha-bridge tts

DESCRIPTION
  Text-to-speech actions

USAGE
  ha-bridge tts <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 tts speak

DESCRIPTION
  Speak a message on a media player

USAGE
  ha-bridge tts speak [flags] <message> [<entity_id...>]

ARGUMENTS
  message string         Message text
  entity_id... string    Entity ID, with or without the tts. prefix; 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)
  --media-player string    Media player to speak on: entity ID, object ID or name
  --language string        Language, such as en-GB
  --cache                  Cache the audio (the default); --no-cache skips it
  --options string         Engine options, such as a voice, as a JSON object
  --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 tts clear-cache

DESCRIPTION
  Clear the speech cache

USAGE
  ha-bridge tts clear-cache [flags]

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

Last updated on