Warehouse CLI

Robust CLI for the next generation of Object ledger and CDN.

• Warehouse CLI
• Usage
• Commands

Usage

$ npm install -g wrhs
$ wrhs COMMAND
running command...
$ wrhs (--version)
wrhs/1.4.0 darwin-arm64 node-v20.9.0
$ wrhs --help [COMMAND]
USAGE
  $ wrhs COMMAND
...

Commands

• wrhs cdn:upload FILEPATH
• wrhs env:create NAME
• wrhs env:get NAME
• wrhs env:list NAME
• wrhs help [COMMANDS]
• wrhs hook:create NAME
• wrhs hook:delete NAME
• wrhs hook:get NAME
• wrhs hook:list NAME
• wrhs object
• wrhs object:create NAME
• wrhs object:get NAME
• wrhs object:get-head NAME
• wrhs object:history NAME
• wrhs object:list-versions NAME
• wrhs object:set-head NAME
• wrhs upload FILEPATH NAME

wrhs cdn:upload FILEPATH

Upload a file to the Warehouse CDN

USAGE
  $ wrhs cdn:upload FILEPATH [-x <value>] [-u <value>] [-g]

FLAGS
  -g, --gzip                  compress the file using gzip
  -u, --cdn_base_url=<value>  cdn base url value that overrides default one configued in the server
  -x, --expiration=<value>    object expiration in human readable format or milliseconds (e.g., 365d, 48h,
                              1607973280797)

DESCRIPTION
  Upload a file to the Warehouse CDN

See code: src/commands/cdn/upload.js

wrhs env:create NAME

Create an object environment

USAGE
  $ wrhs env:create NAME -e <value>

FLAGS
  -e, --env=<value>  (required) object environment (e.g., production, test)

DESCRIPTION
  Create an object environment

See code: src/commands/env/create.js

wrhs env:get NAME

Describe an object enviroment

USAGE
  $ wrhs env:get NAME -e <value>

FLAGS
  -e, --env=<value>  (required) object environment (e.g., production, test)

DESCRIPTION
  Describe an object enviroment

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

wrhs env:list NAME

List all object enviroments

USAGE
  $ wrhs env:list NAME

DESCRIPTION
  List all object enviroments

See code: src/commands/env/list.js

wrhs help [COMMANDS]

Display help for wrhs.

USAGE
  $ wrhs help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for wrhs.

See code: @oclif/plugin-help

wrhs hook:create NAME

Create an object hook

USAGE
  $ wrhs hook:create NAME -u <value>

FLAGS
  -u, --url=<value>  (required) hook url

DESCRIPTION
  Create an object hook

See code: src/commands/hook/create.js

wrhs hook:delete NAME

Delete an object hook

USAGE
  $ wrhs hook:delete NAME -i <value>

FLAGS
  -i, --id=<value>  (required) hook id

DESCRIPTION
  Delete an object hook

See code: src/commands/hook/delete.js

wrhs hook:get NAME

Get an object hook

USAGE
  $ wrhs hook:get NAME -i <value>

FLAGS
  -i, --id=<value>  (required) hook id

DESCRIPTION
  Get an object hook

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

wrhs hook:list NAME

List all object hooks

USAGE
  $ wrhs hook:list NAME

DESCRIPTION
  List all object hooks

See code: src/commands/hook/list.js

wrhs object

USAGE
  $ wrhs object [--build] [--option] [--enum] [--string] [--version] [--help] [--boolean] [--integer]

FLAGS
  --boolean
  --build
  --enum
  --help
  --integer
  --option
  --string
  --version

See code: src/commands/object/index.js

wrhs object:create NAME

Create an object in the Warehouse ledger

USAGE
  $ wrhs object:create NAME -v <value> [-e <value>] [-a <value>] [-x <value>] [-d <value>]

FLAGS
  -a, --variant=<value>     object variant (e.g., en_US)
  -d, --data=<value>        object data (e.g., '{ "foo": "bar" }')
  -e, --env=<value>         object environment (e.g., production, test)
  -v, --version=<value>     (required) object version (e.g., v1.2.1)
  -x, --expiration=<value>  object expiration in human readable format or milliseconds (e.g., 365d, 48h, 1607973280797)

DESCRIPTION
  Create an object in the Warehouse ledger

EXAMPLES
  $ echo '{"foo": "bar"}' | wrhs object:create my-object --version v1.0.0

  $ wrhs object:create my-object --version v1.0.0 --data '{"foo": "bar"}'

See code: src/commands/object/create.js

wrhs object:get NAME

Get an object from the Warehouse ledger

USAGE
  $ wrhs object:get NAME [-e <value>] [-v <value>] [-a <value>]

FLAGS
  -a, --accepted-variants=<value>  accepted object variants (e.g., en_US,fr_CA)
  -e, --env=<value>                object environment (e.g., production, test)
  -v, --version=<value>            object version (e.g., v1.2.1)

DESCRIPTION
  Get an object from the Warehouse ledger

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

wrhs object:get-head NAME

Get the head object from the Warehouse ledger by environment

USAGE
  $ wrhs object:get-head NAME [-e <value>]

FLAGS
  -e, --env=<value>  object environment (e.g., production, test)

DESCRIPTION
  Get the head object from the Warehouse ledger by environment

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

wrhs object:history NAME

Get object history

USAGE
  $ wrhs object:history NAME -e <value>

FLAGS
  -e, --env=<value>  (required) object environment (e.g., production, test)

DESCRIPTION
  Get object history

See code: src/commands/object/history.js

wrhs object:list-versions NAME

List all the object versions

USAGE
  $ wrhs object:list-versions NAME

DESCRIPTION
  List all the object versions

See code: src/commands/object/list-versions.js

wrhs object:set-head NAME

Set the object head to a specific version

USAGE
  $ wrhs object:set-head NAME [-e <value>] [-v <value>] [-f <value>]

FLAGS
  -e, --env=<value>      [default: production] object environment (e.g., production, test)
  -f, --fromEnv=<value>  use head version for env
  -v, --version=<value>  object head version (e.g., v1.2.1)

DESCRIPTION
  Set the object head to a specific version

See code: src/commands/object/set-head.js

wrhs upload FILEPATH NAME

Upload a file to the CDN and create an object in the Warehouse ledger

USAGE
  $ wrhs upload FILEPATH NAME -v <value> [-e <value>] [-a <value>] [-x <value>] [-u <value>] [-g]

FLAGS
  -a, --variant=<value>       object variant (e.g., en_US)
  -e, --env=<value>           object environment (e.g., production, test)
  -g, --gzip                  compress the file using gzip
  -u, --cdn_base_url=<value>  cdn base url value that overrides default one configued in the server
  -v, --version=<value>       (required) object version (e.g., v1.2.1)
  -x, --expiration=<value>    object expiration in human readable format or milliseconds (e.g., 365d, 48h,
                              1607973280797)

DESCRIPTION
  Upload a file to the CDN and create an object in the Warehouse ledger

See code: src/commands/upload.js