@bloq/cloud-cli

cloud-cli

☁️ 💻

• cloud-cli
• Usage
• Commands

Usage

$ npm install -g @bloq/cloud-cli
$ bcl COMMAND
running command...
$ bcl (-v|--version|version)
@bloq/cloud-cli/4.0.0 darwin-x64 node-v14.21.3
$ bcl --help [COMMAND]
USAGE
  $ bcl COMMAND
...

Commands

• bcl client-keys OPERATION
• bcl client-token
• bcl clusters OPERATION
• bcl conf [KEY] [VALUE]
• bcl events
• bcl help [COMMAND]
• bcl login
• bcl logout
• bcl nodes OPERATION
• bcl profile
• bcl signup
• bcl status
• bcl update-password
• bcl verify

bcl client-keys OPERATION

Manage your Bloq client key(s)

USAGE
  $ bcl client-keys OPERATION

ARGUMENTS
  OPERATION  (create|list|remove) [default: list] Specify the type of client-keys operation to run

OPTIONS
  -i, --keyId=keyId  client key id, used with `remove` operation.
  -j, --json         JSON output
  -y, --yes          answer "yes" to prompts

See code: src/commands/client-keys.js

bcl client-token

Generate new client token(s)

USAGE
  $ bcl client-token

OPTIONS
  -j, --json  JSON output

See code: src/commands/client-token.js

bcl clusters OPERATION

Manage your Bloq clusters

USAGE
  $ bcl clusters OPERATION

ARGUMENTS
  OPERATION  (chains|create|disable-service|info|list|remove|services|update) [default: list] Specify the type of
             cluster operation to run

OPTIONS
  -A, --allClusters                list all clusters from every user (admins only)
  -F, --force                      force remove cluster from any user (admins only)
  -S, --sort=sort                  results sorting key
  -a, --all                        list all clusters, started and stopped
  -c, --capacity=capacity          [default: 2] capacity
  -i, --clusterId=clusterId        cluster id
  -j, --json                       JSON output
  -l, --alias=alias                set or update cluster alias
  -s, --serviceId=serviceId        service id
  -t, --authType=(jwt|basic|none)  [default: basic] auth type: jwt, basic or none
  -y, --yes                        answer "yes" to prompts
  --abort                          Abort an (update) operation

See code: src/commands/clusters.js

bcl conf [KEY] [VALUE]

manage configuration

USAGE
  $ bcl conf [KEY] [VALUE]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

OPTIONS
  -d, --cwd=cwd          config file location
  -d, --delete           delete?
  -h, --help             show CLI help
  -k, --key=key          key of the config
  -n, --name=name        config file name
  -p, --project=project  project name
  -v, --value=value      value of the config

See code: conf-cli

bcl events

Get Bloq daily events

USAGE
  $ bcl events

OPTIONS
  -j, --json             JSON output
  -s, --service=service  service name

See code: src/commands/events.js

bcl help [COMMAND]

Display help for bcl.

USAGE
  $ bcl help [COMMAND]

ARGUMENTS
  COMMAND  Command to show help for.

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

See code: @oclif/plugin-help

bcl login

Login to your Bloq account

USAGE
  $ bcl login

OPTIONS
  -j, --json               JSON output
  -p, --password=password  password
  -u, --user=user          email address or account id

See code: src/commands/login.js

bcl logout

Clear local user data

USAGE
  $ bcl logout

OPTIONS
  -j, --json  JSON output
  -y, --yes   answer "yes" to prompts

See code: src/commands/logout.js

bcl nodes OPERATION

Manage your Bloq nodes

USAGE
  $ bcl nodes OPERATION

ARGUMENTS
  OPERATION  (create|list|remove|info|logs|chains|services) [default: list] Specify the type of nodes operation to run

OPTIONS
  -a, --all                   list all nodes
  -i, --nodeId=nodeId         node id
  -j, --json                  JSON output
  -l, --lines=lines           max lines to retrieve
  -s, --serviceId=serviceId   service id
  -t, --authType=(jwt|basic)  [default: basic] auth type (jwt or basic)
  -y, --yes                   answer "yes" to prompts

See code: src/commands/nodes.js

bcl profile

Retrieve user profile

USAGE
  $ bcl profile

OPTIONS
  -j, --json  JSON output

See code: src/commands/profile.js

bcl signup

Setup a new Bloq account

USAGE
  $ bcl signup

See code: src/commands/signup.js

bcl status

Get Bloq services status

USAGE
  $ bcl status

OPTIONS
  -j, --json  JSON output

See code: src/commands/status.js

bcl update-password

Update user password

USAGE
  $ bcl update-password

See code: src/commands/update-password.js

bcl verify

Verifies your Bloq account and complete signup process

USAGE
  $ bcl verify

OPTIONS
  -t, --token=token  verification token
  -u, --user=user    email address or account id

See code: src/commands/verify.js