VisWiz.io CLI
The official VisWiz.io CLI.
Welcome to the VisWiz.io CLI documentation.
The CLI allows you to query and create new projects, builds or images within the VisWiz.io service.
Installation
Install the module using yarn
:
$ yarn add -D viswiz
Or using npm
:
$ npm install -D viswiz
Alternatively, you can download a prepackaged binary for your OS from the Releases page.
Configuration
The following environment keys are used when their corresponding flags are missing:
VISWIZ_API_KEY
- for theapi-key
flagVISWIZ_PROJECT_ID
- for theproject
flag
CI environment variables for popular CI services
are also used for the branch
, message
and revision
flags.
Usage
On popular CI services, assuming
VISWIZ_API_KEY
and VISWIZ_PROJECT_ID
values are configured in the CI environment:
$ viswiz build --image-dir ./path/to/images/directory
Commands
build
$ viswiz build --help Usage: viswiz build [options] Creates a new build on VisWiz.io and sends images
build-result
$ viswiz build-result --help Usage: viswiz build-result [options] Gets or waits
--help
$ viswiz --help Usage: viswiz [options] [command] Options: -V, --version output the version number -k, --api-key [apiKey] The API key of a VisWiz account to use. Defaults to VISWIZ_API_KEY env. -p, --project [projectID] The ID of a VisWiz project to use. Defaults to VISWIZ_PROJECT_ID env. -h, --help output usage information Commands: build [options] Creates a new build on VisWiz.io and sends images
Changelog
The changelog can be found here: CHANGELOG.md.
Authors and license
Author: VisWiz.io.
MIT License, see the included LICENSE.md file.