shougun-cli

Take command of your media

• Usage
• Commands

Usage

$ npm install -g @shougun/cli
$ shougun COMMAND
running command...
$ shougun (-v|--version|version)
@shougun/cli/0.4.1 darwin-x64 node-v14.19.0
$ shougun --help [COMMAND]
USAGE
  $ shougun COMMAND
...

Commands

• shougun borrow [PATH]
• shougun cast [PATH]
• shougun help [COMMAND]
• shougun play [QUERY]
• shougun prefs [QUERY]
• shougun recommend
• shougun return
• shougun search [QUERY]

shougun borrow [PATH]

Copy files for local playback

USAGE
  $ shougun borrow [PATH]

ARGUMENTS
  PATH  Where to save the downloaded videos

OPTIONS
  -h, --help             show CLI help
  -s, --server=server    ip:port to connect to
  -t, --timeout=timeout  in seconds

EXAMPLE
  $ borrow

See code: src/commands/borrow.ts

shougun cast [PATH]

Play by file path

USAGE
  $ shougun cast [PATH]

OPTIONS
  -h, --help               show CLI help
  -l, --language=language  preferred audio language
  -s, --server=server      ip:port to connect to
  -s, --subtitle=subtitle  subtitle language
  -t, --timeout=timeout    in seconds
  --start-time=time        in seconds

EXAMPLE
  $ cast ~/shows/the.good.place.mp4

See code: src/commands/cast.ts

shougun help [COMMAND]

display help for shougun

USAGE
  $ shougun help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

shougun play [QUERY]

Play by title

USAGE
  $ shougun play [QUERY]

OPTIONS
  -h, --help               show CLI help
  -l, --language=language  preferred audio language
  -s, --server=server      ip:port to connect to
  -s, --subtitle=subtitle  subtitle language
  -t, --timeout=timeout    in seconds

  --episode=episode        The episode number to play. If `season` is not also provided, plays this episode of the first
                           season.

  --season=season          The season number to play. If `episode` is not also provided, plays the first episode of that
                           season.

  --start-time=time        in seconds

EXAMPLES
  $ play the good place
  $ play --season 2 the good place
  $ play --season 2 --episode 3 the good place
  $ play --episode 9 the good place

See code: src/commands/play.ts

shougun prefs [QUERY]

Get or set prefs. Omit all flags to view

USAGE
  $ shougun prefs [QUERY]

OPTIONS
  -h, --help               show CLI help
  -l, --language=language  preferred audio language
  -s, --server=server      ip:port to connect to
  -s, --subtitle=subtitle  subtitle language
  -t, --timeout=timeout    in seconds
  --clear                  If set, remove all preferences

EXAMPLES
  $ prefs the good place
  $ prefs the good place --language en
  $ prefs --clear the good place

See code: src/commands/prefs.ts

shougun recommend

Fetch recommendations

USAGE
  $ shougun recommend

OPTIONS
  -h, --help             show CLI help
  -p, --print            print results to stdout instead of casting
  -s, --server=server    ip:port to connect to
  -t, --timeout=timeout  in seconds

EXAMPLE
  $ recommend

See code: src/commands/recommend.ts

shougun return

Return watched data after borrowing

USAGE
  $ shougun return

OPTIONS
  -h, --help             show CLI help
  -s, --server=server    ip:port to connect to
  -t, --timeout=timeout  in seconds

EXAMPLE
  $ return

See code: src/commands/return.ts

shougun search [QUERY]

Search for available titles

USAGE
  $ shougun search [QUERY]

OPTIONS
  -h, --help             show CLI help
  -s, --server=server    ip:port to connect to
  -t, --timeout=timeout  in seconds

EXAMPLE
  $ search the good place

See code: src/commands/search.ts