Start Here
Overview
Control Plane Tour
Supported Platforms
Amazon AWS Cloud Account
Google GCP Cloud Account
Microsoft Azure Account
Create an Environment
Create a Cloud Account
Vocabulary
Support
User and Team Management
Managing Users and Permissions
Install Hub CLI and Toolbox
Managing Your Cluster With AgileStacks
Introducing AgileStacks to Your Cluster
Autoscaling and Initial Scaling
Importing a Vanilla Kubernetes cluster
Import of OpenShift Cluster
OpenShift Import Instructions (from Controlplane)
Tagging Stack Templates and Instances
Deploying Clusters With AgileStacks
Templates and Components
Components, Templates and Stacks
Create a Custom Component
Create a Stack Template
Modifying a Stack
Access Stack Instance Components
Performance Monitoring and Alerting
Stacks Under the Hood - Manifests
SuperHub CLI
CLI Command Reference
hub
hub_api
hub_api_application
hub_api_application_get
hub_api_cloudaccount
hub_api_environment
hub_api_environment_get
hub_api_import
hub_api_instance
hub_api_instance_create
hub_api_instance_delete
hub_api_instance_deploy
hub_api_instance_get
hub_api_instance_kubeconfig
hub_api_instance_sync
hub_api_instance_undeploy
hub_api_secret
hub_api_stack
hub_api_stack_get
hub_api_template
hub_api_template_create
hub_api_template_delete
hub_api_template_get
hub_api_template_init
hub_backup
hub_backup_create
hub_backup_unbundle
hub_doc
hub_elaborate
hub_explain
hub_init
hub_init_component
hub_invoke
hub_login
hub_pull
hub_render
hub_undeploy
hub_init_stack
hub_deploy
hub_kubeconfig
hub_version
hub.yaml
hub_backup_unbundle
Installing the Hub CLI Tool
hub_api_logs
hub_api_cloudaccount_get
hub_api_instance
Managing Kubernetes in the CLI with kubectl
Templating
Toolbox - The CLI Swiss Army Knife
Authenticate to SuperHub
Create a Cloud Account
Stack Design
Tutorials
- All Categories
- SuperHub CLI
- Authenticate to SuperHub
Authenticate to SuperHub
Updated
by Michael Delzer
In order to call SuperHub API from Hub CLI: to query stack instances, sync state, etc. the User must authenticate to obtain a login token. Provide the User's login email and password to hub login command:
hub login -u email@domain.tld [-p password]
Password: ...
export HUB_TOKEN=<long random string>
The CLI will output the User's personal login token which is valid for 1 year. Save it to .envrc or .bash_profile. Now the User can use hub api ... commands such as hub api instance sync ... and make sync.
