Skip to content

cli.md

Latest commit

 

History

History
42 lines (32 loc) · 1.48 KB

cli.md

File metadata and controls

42 lines (32 loc) · 1.48 KB

Command Line Interface

This library has a CLI, which you can run like so:

$ python3 -m plusdeck --help
Usage: python3 -m plusdeck [OPTIONS] COMMAND [ARGS]...

  Control your Plus Deck 2C tape deck.

Options:
  --global / --no-global          Load the global config file at
                                  /etc/plusdeck.yaml (default true when called
                                  with sudo)
  -C, --config-file PATH          A path to a config file
  --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                  Set the log level
  --port TEXT                     The serial port the device is connected to
  --output [text|json]            Output either human-friendly text or JSON
  --help                          Show this message and exit.

Commands:
  config        Configure plusdeck.
  eject         Eject the tape
  expect        Wait for an expected state
  fast-forward  Fast-forward a tape
  pause         Pause the tape
  play          Play a tape
  rewind        Rewind a tape
  stop          Stop the tape
  subscribe     Subscribe to state changes

For more information, use the --help flag for any command.

Output Format

This CLI supports two output formats: text and json. The former will output a human-readable format, and the latter will output JSON. This is mostly relevant for the subscribe command.

Installing the plusdeck Shim

Included in this project is ./bin/plusdeck, a script that you can add to your PATH for convenience.