@mux/cli

mux-cli

Your friendly neighborhood Mux CLI tool. Requires Node 14 or newer.

• mux-cli
• Usage
• Commands

Usage

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

Commands

• mux assets:create INPUT
• mux assets:upload PATH
• mux autocomplete [SHELL]
• mux commands
• mux help [COMMAND]
• mux init [ENVFILE]
• mux live:complete STREAMNAME
• mux live:disable STREAMNAME
• mux live:enable STREAMNAME
• mux plugins
• mux plugins:inspect PLUGIN...
• mux plugins:install PLUGIN...
• mux plugins:link PLUGIN
• mux plugins:uninstall PLUGIN...
• mux plugins:update
• mux sign PLAYBACK-ID
• mux spaces:sign SPACE-ID
• mux update [CHANNEL]

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

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

mux autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ mux autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ mux autocomplete
  $ mux autocomplete bash
  $ mux autocomplete zsh
  $ mux autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

mux commands

list all the commands

USAGE
  $ mux commands

OPTIONS
  -h, --help              Show CLI help.
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --json                  Format output as json.
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

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

OPTIONS
  -f, --force  Will initialize a new file even if one already exists.

See code: src/commands/init.ts

mux live:complete STREAMNAME

Signal to Mux that a live stream has concluded and should be closed.

USAGE
  $ mux live:complete STREAMNAME

ARGUMENTS
  STREAMNAME  the name (coupled with --reference-type) to look up in Mux to yield this livestream

OPTIONS
  -d, --disableAfterCompletion  If set, disables the stream upon completion.
  -t, --streamId=stream-id      [default: stream-id] the type of the provided reference name

See code: src/commands/live/complete.ts

mux live:disable STREAMNAME

Disables a live stream and prevents encoders from streaming to it.

USAGE
  $ mux live:disable STREAMNAME

ARGUMENTS
  STREAMNAME  the name (coupled with --reference-type) to look up in Mux to yield this livestream

OPTIONS
  -t, --streamId=stream-id  [default: stream-id] the type of the provided reference name

See code: src/commands/live/disable.ts

mux live:enable STREAMNAME

Enables a live stream, allowing encoders to streaming to it.

USAGE
  $ mux live:enable STREAMNAME

ARGUMENTS
  STREAMNAME  the name (coupled with --reference-type) to look up in Mux to yield this livestream

OPTIONS
  -t, --streamId=stream-id  [default: stream-id] the type of the provided reference name

See code: src/commands/live/enable.ts

mux plugins

List installed plugins.

USAGE
  $ mux plugins

OPTIONS
  --core  Show core plugins.

EXAMPLE
  $ mux plugins

See code: @oclif/plugin-plugins

mux plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ mux plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

OPTIONS
  -h, --help     Show CLI help.
  -v, --verbose

EXAMPLE
  $ mux plugins:inspect myplugin

See code: @oclif/plugin-plugins

mux plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ mux plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

OPTIONS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ mux plugins:add

EXAMPLES
  $ mux plugins:install myplugin 
  $ mux plugins:install https://github.com/someuser/someplugin
  $ mux plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

mux plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ mux plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
   command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLE
  $ mux plugins:link myplugin

See code: @oclif/plugin-plugins

mux plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ mux plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     Show CLI help.
  -v, --verbose

ALIASES
  $ mux plugins:unlink
  $ mux plugins:remove

See code: @oclif/plugin-plugins

mux plugins:update

Update installed plugins.

USAGE
  $ mux plugins:update

OPTIONS
  -h, --help     Show CLI help.
  -v, --verbose

See code: @oclif/plugin-plugins

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.

  -r, --raw                                  If set, emits only the URL+JWT. Defaults to true for non-TTY.

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

See code: src/commands/sign.ts

mux spaces:sign SPACE-ID

Creates a new signed token for a Mux Space

USAGE
  $ mux spaces:sign SPACE-ID

ARGUMENTS
  SPACE-ID  Space ID for which a token shall be generated.

OPTIONS
  -R, --role=role                    [default: publisher] One of 'publisher' or 'subscriber'.

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

  -p, --participantId=participantId  Optional, user-specified participant ID.

  -r, --raw                          prints a raw JWT to stdout (default if not tty)

See code: src/commands/spaces/sign.ts

mux update [CHANNEL]

update the mux CLI

USAGE
  $ mux update [CHANNEL]

OPTIONS
  --from-local  interactively choose an already installed version

See code: @oclif/plugin-update