Setup a BloqCloud Account

This tutorial will guide you through all the required steps to setup a BloqCloud account and start using our services.

Users require a BloqCloud Account in order to acccess BloqCloud services. A BloqCloud account is associated with an individual user. Organizational support will be provided in a future release.


Install BloqCloud CLI

To setup your BloqCloud account, install our CLI. Open a terminal window and run the following command:

npm i -g @bloq/cloud-cli

WARNING

  • CLI requires that you have installed Node.js >= 8.x.x

  • If you run into permissioning issues installing npm packages globally, please refer to this article.


Check CLI Version

Once you install the CLI, you will have access to the global command bcl. You can run CLI with --version flag to check that everything is working.

❯ bcl --version

# @bloq/cloud-cli/0.1.13 darwin-x64 node-v8.9.4

Signup

Once you confirm the CLI is functioning, you can run the signup command, that will prompt you for basic information (email, name and password) required to create a BloqCloud account. You will need to read and accept our terms to start using the service.

❯ bcl signup

# ? Enter your email address jon@doe.com
# ? Enter your name Jon
# ? Enter your password xxxxxxxxx
# ? Confirm new password xxxxxxxxx
# ? Use of Bloq’s services is subject to the Terms of Service found at https://terms.bloq.cloud.
# Please confirm that you have read and agree to the Terms of Service by selecting [“I accept”] I accept
# ? Please check that your information is correct. Do you want to continue? Yes

After confirming your information, a BloqCloud Account will be created and an email confirmation email will be sent to the email provided. Within the email you will find your Verfication Token.


Verify Account

In order to verfy your account, check your email and have the confirmation email at hand. Run the CLI verify command which will prompt you for your Email Address and Verfication Token contained in the email.

❯ bcl verify

# ? Enter your email address or account id your@email.com
# ? Enter your verification token xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
# ✔ The account your@email.com has been validated
# ℹ You can now start a new session running the command: bcl login -u your@email.com

Login & Start Using BloqCloud

When your account is succesfully created, you can start using BloqCloud services, manage your user information and generate client keys using the CLI. To start using BLoqCloud services, start a new session using the login command:

❯ bcl login -u your@email.com

# ℹ Account saved. Next time you only need -p flag (--password) to login.
# ℹ Login with user your@email.com
# ? Enter your password xxxxxxxx
✔ Login success. Your session expires in 12h.

TIP

  • Each CLI session expires in 12h. After that, you will need to re-login to continue using services.

  • You can run the login command using your Email Address or BloqCloud Account ID.

  • Most commands allow you to add arguments using flags. If you miss a required flag, you will be prompted to enter the argument manually.

  • Run bcl help to list available commands and their associated options.

Last updated: 5/10/2019, 8:09:11 PM