Skip to main content

Instance Management

An instance in Tangram CLI represents a Tangram OS deployment environment that the CLI connects to, for example you can have local, staging, or production environments to run Tangram CLI against. The instance command group is a list of commands used to manage Tangram OS deployment environments. These commands allow you to add, remove, switch, and authenticate instances, as well as view and update instance details.

Get current instance:

instance

Add a new instance:

instance add prod --host <prod-host-url> --username <username> --password <password>

Switch between instances:

use prod

Remove an instance:

instance rm test

Note: If you remove the currently active instance, you should switch to another instance using tangram use.

List all instances:

instance ls

View instance URL:

instance get-url local

Update instance URL:

instance set-url prod new-url

Switch to a specific instance

use <instance-name>

Authenticate with an instance

login --instance <instance-name> --username <username> --password <password>