Getting Started
To install VESSL CLI, use following command.
pip install vessl
To get started,
- 1.
- 2.In your terminal, run
vessl configureto setup your environment. - 3.A page on your browser will asking for access. Click GRANT ACCESS.
- 4.Choose your default organization.
- 5.Choose your default project.
vessl configure [OPTIONS]
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 |
Set the default organization so that you do not enter the organization every time you execute the
vessl command.vessl configure organization [ORGANIZATION]
Argument | Description |
|---|---|
ORGANIZATION | New default organization |
Set the default organization so that you do not enter the project every time you execute the
vessl command.vessl configure project [PROJECT]
Argument | Description |
|---|---|
PROJECT | New default project |
vessl configure list
You can configure your VESSL environment in multiple ways. Here is a list of ways, in order of precedence.
- 1.Command line arguments / options:
-o,-poptions andORGANIZATION,PROJECTarguments. - 2.Credentials file option:
-f, a path to a file containing configuration data. - 3.Environment variables:
VESSL_ACCESS_TOKEN,VESSL_DEFAULT_ORGANIZATION. - 4.Credentials file environment variable:
VESSL_CREDENTIALS_FILE. - 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 24d ago