wrhs

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 (-v|--version|version)
wrhs/1.3.1 darwin-arm64 node-v18.14.1
$ wrhs --help [COMMAND]
USAGE
  $ wrhs COMMAND
...

Commands

• wrhs cdn
• wrhs cdn:upload FILEPATH
• wrhs env:create NAME
• wrhs env:get NAME
• wrhs env:list NAME
• wrhs help [COMMAND]
• 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

USAGE
  $ wrhs cdn

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

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

wrhs cdn:upload FILEPATH

Upload a file to the Warehouse CDN

USAGE
  $ wrhs cdn:upload FILEPATH

OPTIONS
  -u, --cdn_base_url=cdn_base_url  cdn base url value that overrides default one configued in the server

  -x, --expiration=expiration      object expiration in human readable format or milliseconds (e.g., 365d, 48h,
                                   1607973280797)

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

wrhs env:create NAME

Create an object enviroment

USAGE
  $ wrhs env:create NAME

OPTIONS
  -e, --env=env  (required) object environment (e.g., production, test)

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

wrhs env:get NAME

Describe an object enviroment

USAGE
  $ wrhs env:get NAME

OPTIONS
  -e, --env=env  (required) object environment (e.g., production, test)

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

wrhs env:list NAME

List all object enviroments

USAGE
  $ wrhs env:list NAME

See code: src/commands/env/list.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 hook:create NAME

Create an object hook

USAGE
  $ wrhs hook:create NAME

OPTIONS
  -u, --url=url  (required) hook url

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

wrhs hook:delete NAME

Delete an object hook

USAGE
  $ wrhs hook:delete NAME

OPTIONS
  -i, --id=id  (required) hook id

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

wrhs hook:get NAME

Get an object hook

USAGE
  $ wrhs hook:get NAME

OPTIONS
  -i, --id=id  (required) hook id

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

wrhs hook:list NAME

List all object hooks

USAGE
  $ wrhs hook:list NAME

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

wrhs object

USAGE
  $ wrhs object

OPTIONS
  --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

OPTIONS
  -a, --variant=variant        object variant (e.g., en_US)
  -d, --data=data              object data (e.g., '{ "foo": "bar" }')
  -e, --env=env                object environment (e.g., production, test)
  -v, --version=version        (required) object version (e.g., v1.2.1)

  -x, --expiration=expiration  object expiration in human readable format or milliseconds (e.g., 365d, 48h,
                               1607973280797)

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

wrhs object:get NAME

Get an object from the Warehouse ledger

USAGE
  $ wrhs object:get NAME

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

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

OPTIONS
  -e, --env=env  object environment (e.g., production, test)

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

wrhs object:history NAME

Get object history

USAGE
  $ wrhs object:history NAME

OPTIONS
  -e, --env=env  (required) object environment (e.g., production, test)

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

wrhs object:list-versions NAME

List all the object versions

USAGE
  $ wrhs object:list-versions NAME

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

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

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

OPTIONS
  -a, --variant=variant            object variant (e.g., en_US)
  -e, --env=env                    object environment (e.g., production, test)
  -u, --cdn_base_url=cdn_base_url  cdn base url value that overrides default one configued in the server
  -v, --version=version            (required) object version (e.g., v1.2.1)

  -x, --expiration=expiration      object expiration in human readable format or milliseconds (e.g., 365d, 48h,
                                   1607973280797)

See code: src/commands/upload.js

Changelog

1.3.1

26 April 2023

• feat(cli): add env and hook endpoints + other updates #49
• chore: release 1.3.1 13016d6