@mux/cli

mux-cli

Your friendly neighborhood Mux CLI tool

• mux-cli
• Usage
• Commands

Usage

$ npm install -g @mux/cli
$ mux COMMAND
running command...
$ mux (-v|--version|version)
@mux/cli/0.4.2 linux-x64 node-v8.17.0
$ mux --help [COMMAND]
USAGE
  $ mux COMMAND
...

Commands

• mux assets:create INPUT
• mux assets:upload PATH
• mux help [COMMAND]
• mux init [ENVFILE]
• mux sign PLAYBACK-ID

mux assets:create INPUT

Create a new asset in Mux using a file that's already available online

USAGE
  $ mux assets:create INPUT

ARGUMENTS
  INPUT  input URL for the file you'd like to create this asset from

OPTIONS
  -p, --private  add a private playback policy to the created asset

See code: src/commands/assets/create.ts

mux assets:upload PATH

Create a new asset in Mux via a local file

USAGE
  $ mux assets:upload PATH

ARGUMENTS
  PATH  local path for the file (or folder) you'd like to upload

OPTIONS
  -c, --concurrent=concurrent  [default: 3] max number of files to upload at once
  -f, --filter=filter          regex that filters the selected destination if the provided path is a folder
  -p, --private                add a private playback policy to the created asset

See code: src/commands/assets/upload.ts

mux help [COMMAND]

display help for mux

USAGE
  $ mux help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mux init [ENVFILE]

set up a user-level config

USAGE
  $ mux init [ENVFILE]

ARGUMENTS
  ENVFILE  path to a Mux access token .env file

See code: src/commands/init.ts

mux sign PLAYBACK-ID

Creates a new signed URL token for a playback ID

USAGE
  $ mux sign PLAYBACK-ID

ARGUMENTS
  PLAYBACK-ID  Playback ID to create a signed URL token for.

OPTIONS
  -e, --expiresIn=expiresIn       [default: 7d] How long the signature is valid for. If no unit is specified,
                                  milliseconds is assumed.

  -t, --type=video|thumbnail|gif  [default: video] What type of token this signature is for.

See code: src/commands/sign.ts