Get Started

Getting Started¶

Please follow the installation procedure and then run the following:

Show the version of ubiops-cli:

ubiops --version

Sign in & sign out¶

The default API host url is https://api.ubiops.com/v2.1/ (UbiOps SaaS). For on-premises installations of UbiOps, set your API url using the --api option in the signin commands below.

• Sign in using your credentials (username/password):

  ubiops signin --api https://api.ubiops.com/v2.1/
  

  You will be prompted to fill in your credentials (email + password). It's also possible to provide your email and password directly using the --email and --password options.

  A temporary access token is generated in the background, which provides you access for 3 hours.

• Sign in using a service token:

  ubiops signin --api https://api.ubiops.com/v2.1/ --token
  

  You will be prompted to fill in your token. It's also possible to provide your token directly using the --password option.

Show if you are authorized:

ubiops status

Sign out:

ubiops signout

Managing resources¶

Show your projects:

ubiops projects list

Set a current project:

ubiops current_project set <project_name>

Show your deployments:

ubiops deployments list