Skip to main content
Version: 0.6.12

swcli instance

Overview​

swcli [GLOBAL OPTIONS] instance [OPTIONS] <SUBCOMMAND> [ARGS]

The instance command includes the following subcommands:

  • info
  • list (ls)
  • login
  • logout
  • use (select)

swcli instance info​

swcli [GLOBAL OPTIONS] instance info [OPTIONS] <INSTANCE>

instance info outputs detailed information about the specified Starwhale Instance.

INSTANCE is an instance URI.

swcli instance list​

swcli [GLOBAL OPTIONS] instance list [OPTIONS]

instance list shows all Starwhale Instances.

swcli instance login​

swcli [GLOBAL OPTIONS] instance login [OPTIONS] <INSTANCE>

instance login connects to a Server/Cloud instance and makes the specified instance default.

INSTANCE is an instance URI.

OptionRequiredTypeDefaultsDescription
--usernameNStringThe login username.
--passwordNStringThe login password.
--tokenNStringThe login token.
--aliasYStringThe alias of the instance. You can use it anywhere that requires an instance URI.

--username and --password can not be used together with --token.

swcli instance logout​

swcli [GLOBAL OPTIONS] instance logout [INSTANCE]

instance logout disconnects from the Server/Cloud instance, and clears information stored in the local storage.

INSTANCE is an instance URI. If it is omiited, the default instance is used instead.

swcli instance use​

swcli [GLOBAL OPTIONS] instance use <INSTANCE>

instance use make the specified instance default.

INSTANCE is an instance URI.