Skip to content

usage.md

Latest commit

 

History

History
866 lines (510 loc) · 10.9 KB

usage.md

File metadata and controls

866 lines (510 loc) · 10.9 KB

Available commands

Usage:

$ alga [OPTIONS] COMMAND [ARGS]...

Options:

  • --tv TEXT: Specify which TV the command should be sent to
  • --timeout INTEGER: Number of seconds to wait before a response (default 10)
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • adhoc: Send raw request to the TV
  • app: Apps installed on the TV
  • channel: TV channels
  • input: HDMI and similar inputs
  • media: Control the playing media
  • power: Turn TV (or screen) on and off
  • remote: Remote control button presses
  • sound-output: Audio output device
  • tv: Set up TVs to manage via Alga
  • version: Print Alga version
  • volume: Audio volume

alga adhoc

Send raw request to the TV

Usage:

$ alga adhoc [OPTIONS] PATH [DATA]

Arguments:

  • PATH: [required]
  • [DATA]

Options:

  • --help: Show this message and exit.

alga app

Apps installed on the TV

Usage:

$ alga app [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • close: Close the provided app
  • current: Get the current app
  • info: Show info about specific app
  • launch: Launch an app
  • list: List installed apps
  • pick: Show picker for selecting an app.

alga app close

Close the provided app

Usage:

$ alga app close [OPTIONS] APP_ID

Arguments:

  • APP_ID: [required]

Options:

  • --help: Show this message and exit.

alga app current

Get the current app

Usage:

$ alga app current [OPTIONS]

Options:

  • --help: Show this message and exit.

alga app info

Show info about specific app

Usage:

$ alga app info [OPTIONS] APP_ID

Arguments:

  • APP_ID: [required]

Options:

  • --help: Show this message and exit.

alga app launch

Launch an app

Usage:

$ alga app launch [OPTIONS] APP_ID [DATA]

Arguments:

  • APP_ID: [required]
  • [DATA]

Options:

  • --help: Show this message and exit.

alga app list

List installed apps

Usage:

$ alga app list [OPTIONS]

Options:

  • --help: Show this message and exit.

alga app pick

Show picker for selecting an app.

Usage:

$ alga app pick [OPTIONS]

Options:

  • --help: Show this message and exit.

alga channel

TV channels

Usage:

$ alga channel [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • current: Get the current channel
  • down: Change channel down
  • list: List available channels
  • pick: Show picker for selecting a channel.
  • set: Change to specific channel
  • up: Change channel up

alga channel current

Get the current channel

Usage:

$ alga channel current [OPTIONS]

Options:

  • --help: Show this message and exit.

alga channel down

Change channel down

Usage:

$ alga channel down [OPTIONS]

Options:

  • --help: Show this message and exit.

alga channel list

List available channels

Usage:

$ alga channel list [OPTIONS]

Options:

  • --help: Show this message and exit.

alga channel pick

Show picker for selecting a channel.

Usage:

$ alga channel pick [OPTIONS]

Options:

  • --help: Show this message and exit.

alga channel set

Change to specific channel

Usage:

$ alga channel set [OPTIONS] VALUE

Arguments:

  • VALUE: [required]

Options:

  • --help: Show this message and exit.

alga channel up

Change channel up

Usage:

$ alga channel up [OPTIONS]

Options:

  • --help: Show this message and exit.

alga input

HDMI and similar inputs

Usage:

$ alga input [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List available inputs
  • pick: Show picker for selecting an input.
  • set: Switch to given input

alga input list

List available inputs

Usage:

$ alga input list [OPTIONS]

Options:

  • --help: Show this message and exit.

alga input pick

Show picker for selecting an input.

Usage:

$ alga input pick [OPTIONS]

Options:

  • --help: Show this message and exit.

alga input set

Switch to given input

Usage:

$ alga input set [OPTIONS] VALUE

Arguments:

  • VALUE: [required]

Options:

  • --help: Show this message and exit.

alga media

Control the playing media

Usage:

$ alga media [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • fast-forward: Fast forward media
  • pause: Pause media
  • play: Play media
  • rewind: Rewind media
  • stop: Stop media

alga media fast-forward

Fast forward media

Usage:

$ alga media fast-forward [OPTIONS]

Options:

  • --help: Show this message and exit.

alga media pause

Pause media

Usage:

$ alga media pause [OPTIONS]

Options:

  • --help: Show this message and exit.

alga media play

Play media

Usage:

$ alga media play [OPTIONS]

Options:

  • --help: Show this message and exit.

alga media rewind

Rewind media

Usage:

$ alga media rewind [OPTIONS]

Options:

  • --help: Show this message and exit.

alga media stop

Stop media

Usage:

$ alga media stop [OPTIONS]

Options:

  • --help: Show this message and exit.

alga power

Turn TV (or screen) on and off

Usage:

$ alga power [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • off: Turn TV off
  • on: Turn TV on via Wake-on-LAN
  • screen-off: Turn TV screen off
  • screen-on: Turn TV screen on
  • screen-state: Show if TV screen is active or off

alga power off

Turn TV off

Usage:

$ alga power off [OPTIONS]

Options:

  • --help: Show this message and exit.

alga power on

Turn TV on via Wake-on-LAN

Usage:

$ alga power on [OPTIONS]

Options:

  • --help: Show this message and exit.

alga power screen-off

Turn TV screen off

Usage:

$ alga power screen-off [OPTIONS]

Options:

  • --help: Show this message and exit.

alga power screen-on

Turn TV screen on

Usage:

$ alga power screen-on [OPTIONS]

Options:

  • --help: Show this message and exit.

alga power screen-state

Show if TV screen is active or off

Usage:

$ alga power screen-state [OPTIONS]

Options:

  • --help: Show this message and exit.

alga remote

Remote control button presses

Usage:

$ alga remote [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • send: Send a button press to the TV

alga remote send

Send a button press to the TV

Usage:

$ alga remote send [OPTIONS] BUTTON

Arguments:

  • BUTTON: [required]

Options:

  • --help: Show this message and exit.

alga sound-output

Audio output device

Usage:

$ alga sound-output [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • get: Show the current output device
  • pick: Show picker for selecting a sound output...
  • set: Change the output device

alga sound-output get

Show the current output device

Usage:

$ alga sound-output get [OPTIONS]

Options:

  • --help: Show this message and exit.

alga sound-output pick

Show picker for selecting a sound output device.

Usage:

$ alga sound-output pick [OPTIONS]

Options:

  • --help: Show this message and exit.

alga sound-output set

Change the output device

Usage:

$ alga sound-output set [OPTIONS] VALUE

Arguments:

  • VALUE: [required]

Options:

  • --help: Show this message and exit.

alga tv

Set up TVs to manage via Alga

Usage:

$ alga tv [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • add: Pair a new TV
  • list: List current TVs
  • remove: Remove a TV
  • rename: Change the identifier for a TV
  • set-default: Set the default TV

alga tv add

Pair a new TV

Usage:

$ alga tv add [OPTIONS] NAME [HOSTNAME]

Arguments:

  • NAME: [required]
  • [HOSTNAME]: [default: lgwebostv]

Options:

  • --help: Show this message and exit.

alga tv list

List current TVs

Usage:

$ alga tv list [OPTIONS]

Options:

  • --help: Show this message and exit.

alga tv remove

Remove a TV

Usage:

$ alga tv remove [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --help: Show this message and exit.

alga tv rename

Change the identifier for a TV

Usage:

$ alga tv rename [OPTIONS] OLD_NAME NEW_NAME

Arguments:

  • OLD_NAME: [required]
  • NEW_NAME: [required]

Options:

  • --help: Show this message and exit.

alga tv set-default

Set the default TV

Usage:

$ alga tv set-default [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --help: Show this message and exit.

alga version

Print Alga version

Usage:

$ alga version [OPTIONS]

Options:

  • --help: Show this message and exit.

alga volume

Audio volume

Usage:

$ alga volume [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • down: Turn volume down
  • get: Get current volume
  • mute: Mute audio
  • set: Set volume to specific amount
  • unmute: Unmute audio
  • up: Turn volume up

alga volume down

Turn volume down

Usage:

$ alga volume down [OPTIONS]

Options:

  • --help: Show this message and exit.

alga volume get

Get current volume

Usage:

$ alga volume get [OPTIONS]

Options:

  • --help: Show this message and exit.

alga volume mute

Mute audio

Usage:

$ alga volume mute [OPTIONS]

Options:

  • --help: Show this message and exit.

alga volume set

Set volume to specific amount

Usage:

$ alga volume set [OPTIONS] VALUE

Arguments:

  • VALUE: [required]

Options:

  • --help: Show this message and exit.

alga volume unmute

Unmute audio

Usage:

$ alga volume unmute [OPTIONS]

Options:

  • --help: Show this message and exit.

alga volume up

Turn volume up

Usage:

$ alga volume up [OPTIONS]

Options:

  • --help: Show this message and exit.