VESSL Docs
Search…
Getting Started

Overview

To get started,
  1. 1.
  2. 2.
    In your terminal, run vessl configure to setup your environment.
  3. 3.
    A page on your browser will asking for access. Click GRANT ACCESS.
  4. 4.
    Choose your default organization.
  5. 5.
    Choose your default project.

Setup a Vessl environment

1
vessl configure [OPTIONS]
Copied!
Option
Description
-t, --access-token
Access token used for authorization
-o, --organization
Default organization
-p, --project
Default project
-f, --credentials-file
Path to file containing configuration data
--renew-token
Renew access token

Change the default organization

1
vessl configure organization [ORGANIZATION]
Copied!
Argument
Description
ORGANIZATION
New default organization

Change the default project

1
vessl configure project [PROJECT]
Copied!
Argument
Description
PROJECT
New default project

View the current configuration

1
vessl configure list
Copied!

Configuration Precedence

You can configure your Vessl environment in multiple ways. Here is a list of ways, in order of precedence.
  1. 1.
    Command line arguments / options: -o , -p options and ORGANIZATION , PROJECT arguments.
  2. 2.
    Credentials file option: -f , a path to a file containing configuration data.
  3. 3.
    Environment variables: VESSL_ACCESS_TOKEN, VESSL_DEFAULT_ORGANIZATION .
  4. 4.
    Credentials file environment variable: VESSL_CREDENTIALS_FILE .
  5. 5.
    Default credentials file: a configuration file maintained by Vessl located at ~/.vessl/config .
Note that the --renew-token flag for vessl configure will take precedence over other methods and renew your access token.
Last modified 1mo ago