Vidiff CLI

• Usage
• Commands

Usage

npx vidiff init --url https://example.com

Commands

• vidiff init
• vidiff create-build
• vidiff help [COMMAND]

vidiff init

Creates the files needed for Vidiff to work

USAGE
  $ vidiff init

OPTIONS
  -e, --entry=entry  [default: test/scenario.js] The location of the scenario file
  -u, --url=url      [default: https://google.com] The URL to run the scenario on

DESCRIPTION
  ...
  Creates two files in your repository:
  - A .vidiffrc configuration file, with default capabilities and branchToUrlMapping
  - A scenario file

See code: src/commands/init.js

vidiff create-build

Launches a new build

USAGE
  $ vidiff create-build

OPTIONS
  -t, --apiToken=apiToken                  (required) Your API token. Availlable in the account page.
  -p, --projectId=projectId                (required) The id of the project. Availlable in the project page.
  -b, --baselineBranch=baselineBranch      [default: the current branch] The baseline branch.
  -c, --comparisonBranch=comparisonBranch  [default: the current branch] The comparison branch.

See code: src/commands/create-build.js

vidiff help [COMMAND]

display help for vidiff

USAGE
  $ vidiff help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help