vy-cli

Vidyard CLI to speed up Call-To-Action development.

• Usage
• Configuration
• Commands

Usage

$ npm install -g @vidyard/vy-cli
$ vy-cli COMMAND
running command...
$ vy-cli (-v|--version|version)
@vidyard/vy-cli/1.1.0 darwin-x64 node-v15.12.0
$ vy-cli --help [COMMAND]
USAGE
  $ vy-cli COMMAND
...

Configuration

Most of the CLI commands have arguments and flags that can be passed to them that have default fallback values. These default fallback values can be overridden via a configuration file placed on the following path depending on your OS:

Unix: ~/.config/vy-cli/config.json
Windows: %LOCALAPPDATA%\vy-cli\config.json

Can be overridden with XDG_CONFIG_HOME

The following values can be configured:

defaultBrowser

   DEFAULT VALUE:
      "google chrome"
      
   POSSIBLE VALUES:
      "google chrome", "firefox"

Example Configuration:

{
  "defaultBrowser": "google chrome"
}

Commands

• vy-cli cta:designer [CTAPROJECTPATH]
• vy-cli cta:init
• vy-cli cta:publish HTMLFILE NAME AUTHTOKEN [EVENTTYPE]
• vy-cli help [COMMAND]

vy-cli cta:designer [CTAPROJECTPATH]

Call To Action (VY Actions) local development aid

USAGE
  $ vy-cli cta:designer [CTAPROJECTPATH]

EXAMPLES
  $ vy-cli cta:designer .
  $ vy-cli cta:designer ./path/to/cta

See code: src/commands/cta/designer.ts

vy-cli cta:init

Call-To-Action local project initialization command, creates all required files for a CTA in your current working directory or in a path specified as an argument.Used to init a project for cta:designer.

USAGE
  $ vy-cli cta:init

OPTIONS
  -n, --name=name  [default: My New CTA]
  -p, --path=path
  -t, --type=type  [default: fullscreen]

EXAMPLES
  $ vy-cli cta:init --name="My New CTA" --path=./directory/
  $ vy-cli cta:init --name "My New CTA" --path ./directory/
  $ vy-cli cta:init -n="My New CTA" -p=./directory/
  $ vy-cli cta:init -n "My New CTA" -p ./directory/

See code: src/commands/cta/init.ts

vy-cli cta:publish HTMLFILE NAME AUTHTOKEN [EVENTTYPE]

Publish Call To Action (VY Actions) to an org

USAGE
  $ vy-cli cta:publish HTMLFILE NAME AUTHTOKEN [EVENTTYPE]

ARGUMENTS
  HTMLFILE   Input CTA HTML file you would like to add to your org.
  NAME       Input the name of the CTA.
  AUTHTOKEN  Input the authToken of the account you would like to add the CTA to.

  EVENTTYPE  [default: fullscreen] Input the type of event. Eg. “simple_post_roll”, “simple_overlay”, “simple_email”,
             “fullscreen”, “annotation”, “marketo_form”, “sharing_page_action”

EXAMPLE
  $ vy-cli cta:publish index.html "3 Panel CTA [PROS-1337]" authToken

See code: src/commands/cta/publish.ts

vy-cli help [COMMAND]

display help for vy-cli

USAGE
  $ vy-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help