Skip to content
Flawless CLI management of build pipelines & asset deployments for your front-end apps powered by Warehouse.ai
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
bin
src
test
.eslintrc
.gitattributes
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
SECURITY.md
package-lock.json
package.json

README.md

wrhs

Version npm License npm Downloads Build Status Dependencies

CLI for Warehouse.ai. CLI to manage build pipelines & asset deployments for your front-end apps powered by Warehouse.ai. There is also a web-based UI available for Warehouse.ai.

Install

Global installation of the CLI is preferred.

npm install -g wrhs

Ensure configuration is setup before you run any commands.

Usage

$ npm install -g wrhs
$ wrhs COMMAND
running command...
$ wrhs (-v|--version|version)
wrhs/0.5.0 darwin-x64 node-v8.16.0
$ wrhs --help [COMMAND]
USAGE
  $ wrhs COMMAND
...

Configuration

wrhs configuration can be passed in via CLI flags (more information on this below), or by creating a configuration file at ~/.wrhs. Note: by default the CLI expects the configuration file to be available under your home folder.

Example .wrhs file:

{
  "hosts": {
    "wrhs": "warehouse.ai",
    "status": "warehouse-status.ai"
  },
  "auth": {
    "user": "username",
    "pass": "password"
  }
}

Commands

wrhs build PACKAGE ENV

Triggers a build for a specific version on warehouse.

USAGE
  $ wrhs build PACKAGE ENV

ARGUMENTS
  PACKAGE  The package to build. Make sure it is in the form packageName@version where `version` is the specific version
           to build

  ENV      The environment to build in

OPTIONS
  -h, --host=host                The base url for the warehouse API
  -j, --json                     Output response data as JSON
  -m, --promote                  Should promotion happen on successful build. Defaults to false
  -p, --pass=pass                Password
  -s, --status-host=status-host  The base url for the warehouse status API
  -u, --user=user                Username

DESCRIPTION
  -m Optionally specify if promotion should happen on successful build

See code: src/commands/build.js

wrhs get:build PACKAGE ENV [LOCALE]

Gets information about builds that exist in warehouse.

USAGE
  $ wrhs get:build PACKAGE ENV [LOCALE]

ARGUMENTS
  PACKAGE  The package to get builds for
  ENV      The environment to get builds for
  LOCALE   The specific locale to fetch. Defaults to en-US

OPTIONS
  -h, --host=host                The base url for the warehouse API
  -j, --json                     Output response data as JSON
  -p, --pass=pass                Password
  -s, --status-host=status-host  The base url for the warehouse status API
  -u, --user=user                Username

DESCRIPTION
  If no version is specified, the head version will be returned.

See code: src/commands/get/build.js

wrhs get:head PACKAGE ENV

Shows information about the head build for the given package in the given environment.

USAGE
  $ wrhs get:head PACKAGE ENV

ARGUMENTS
  PACKAGE  The package to get the head build for
  ENV      The environment to get the head build for

OPTIONS
  -h, --host=host                The base url for the warehouse API
  -j, --json                     Output response data as JSON
  -p, --pass=pass                Password
  -s, --status-host=status-host  The base url for the warehouse status API
  -u, --user=user                Username

DESCRIPTION
  Accepts an optional locale.

See code: src/commands/get/head.js

wrhs get:status PACKAGE ENV

Get information about the status of a build.

USAGE
  $ wrhs get:status PACKAGE ENV

ARGUMENTS
  PACKAGE  The package to get status information for
  ENV      The environment to get status information for

OPTIONS
  -e, --events                   Should status events be fetched. Defaults to false
  -h, --host=host                The base url for the warehouse API
  -j, --json                     Output response data as JSON
  -l, --locale=locale            Only get events for a specific locale
  -p, --pass=pass                Password
  -s, --status-host=status-host  The base url for the warehouse status API
  -u, --user=user                Username

DESCRIPTION
  -e can be used to get the more granular status events.

See code: src/commands/get/status.js

wrhs help [COMMAND]

display help for wrhs

USAGE
  $ wrhs help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

wrhs promote PACKAGE ENV

Promotes a build for a specific version on warehouse.

USAGE
  $ wrhs promote PACKAGE ENV

ARGUMENTS
  PACKAGE  The package to promote. Make sure it is in the form packageName@version where `version` is the specific
           version to promote. If NOT using the -b optional build flag,please make sure that the specific version is
           already built.

  ENV      The environment to promote to

OPTIONS
  -b, --build                    Should build the package before promoting. Defaults to false
  -h, --host=host                The base url for the warehouse API
  -j, --json                     Output response data as JSON
  -p, --pass=pass                Password
  -s, --status-host=status-host  The base url for the warehouse status API
  -u, --user=user                Username

DESCRIPTION
  -b Optionally specify to build as well

See code: src/commands/promote.js

You can’t perform that action at this time.