Skip to main content

How to install and initialize Database Lab CLI


Install CLI and connect

  1. Install Database Lab CLI:
curl -sSL | bash
  1. (optional) Connect to Database Lab Engine using SSH port forwarding

A Database Lab instance might be running behind firewalls and opening proper ports might be impossible or prohibited. In this case, SSH keys should be on the server with Database Lab Engine in order to use this connection option.

In a separate terminal tab launch SSH port forwarding. Use http://localhost:2344 as URL in the step 3 below.

ssh -NTML 2344:localhost:2345 ssh://USERNAME@HOSTNAME:22 -i ~/.ssh/id_rsa
  1. Initialize configuration. Use URL and verification token of your instance. Instead of using verification token you can generate and use your personal access token. See details here.
dblab init --environment-id=ENV_ID --url=URL --token=TOKEN
  • --environment-id - an arbitrary environment ID of Database Lab instance's API
  • --url - URL of Database Lab instance's API
  • --token - verification token of the Database Lab instance to send API requests

You can also run dblab config at any time to change your settings or create a new configuration.

  1. Test your configuration with instance status request dblab instance status:
"status": {
"code": "OK",
"message": "Instance is ready"