Skip to main content

Workspace Commands

In this section, you will learn about Workspace commands.


CommandDescription
stk exit workspaceTerminates the active session in a Workspace.
stk use workspaceAccesses a Workspace.
stk list workspaceLists all Workspaces available to your account.

stk exit workspace

The stk exit workspace command ends the active session in a Workspace. After you run this command, all subsequent actions affect only your local environment.

Usage

stk exit workspace

stk use workspace

The stk use workspace command allows you to access a Workspace. To access the available Workspaces, you must first log in to the STK CLI using the stk login command.

Usage

stk use workspace [NAME]
info

To switch Workspaces, run the stk use workspace command again and specify the name of the Workspace you want to use.

Parameters

OptionDescriptionExample
NAMEThe name of the Workspace that you want to access. If you do not specify a name, the CLI displays a list of available Workspaces in the terminal so that you can choose one.
stk use workspace my-workspace-slug
-h, --helpDisplays the command help and exits.
stk use workspace --help

stk list workspace

The stk list workspace command lists all Workspaces available to your account. To view the Workspaces, you must first log in to the STK CLI using the stk login command.

Usage

stk list workspace