Studio

Persistent GPU dev workspaces.

Usage:

lightning studio [OPTIONS] COMMAND [ARGS]...

Commands

Command	Description
`connect`	Connect to a Studio.
`cp`	Copy a Studio file.
`create`	Create a new Studio.
`delete`	Delete a Studio.
`env`	Manage Studio environment variables.
`list`	List Studios in a teamspace.
`ls`	List contents of a directory in Studio.
`open`	Open a local file or folder in a Lightning Studio.
`rm`	Remove a Studio file or directory.
`ssh`	SSH into a Studio.
`start`	Start a Studio — a persistent GPU cloud workspace.
`stop`	Stop a Studio.
`switch`	Switch a Studio to a different machine type.

lightning studio connect

Connect to a Studio.

Usage:

lightning studio connect [OPTIONS] [NAME]

Arguments

Name	Type	Required	Description
`NAME`	`text`	no	Optional Studio name to connect to.

Options

Option	Type	Required	Default	Description
`--teamspace`	`TEXT`	no	`Sentinel.UNSET`	Override default teamspace (format: owner/teamspace)
`--cloud`	`TEXT`	no	`Sentinel.UNSET`	Cloud provider or cloud account to create the studio on. Defaults to teamspace default.
`--machine`	`[CPU_SMALL\|CPU\|CPU_X_2\|CPU_X_4\|CPU_X_8\|CPU_X_16\|DATA_PREP\|DATA_PREP_MAX\|DATA_PREP_ULTRA\|T4_SMALL\|T4\|T4_X_2\|T4_X_4\|T4_X_8\|L4\|L4_X_2\|L4_X_4\|L4_X_8\|L40S\|L40S_X_2\|L40S_X_4\|L40S_X_8\|RTXP_6000\|RTXP_6000_X_2\|RTXP_6000_X_4\|RTXP_6000_X_8\|A100\|A100_X_2\|A100_X_4\|A100_X_8\|H100\|H100_X_2\|H100_X_4\|H100_X_8\|H200\|H200_X_2\|H200_X_4\|H200_X_8\|B200\|B200_X_8]`	no	`Sentinel.UNSET`	The machine type to start the studio on. Defaults to CPU-4
`--gpus`	`TEXT`	no	`Sentinel.UNSET`	The number and type of GPUs to start the studio on (format: TYPE:COUNT, e.g. L4:4)
`--studio-type`	`TEXT`	no	`Sentinel.UNSET`	The base studio template name to use for creating the studio. Must be lowercase and hyphenated (use ‘-’ instead of spaces). Run ‘lightning base-studio list’ to see all available templates. Defaults to the first available template.
`--interruptible`	—	no	`Sentinel.UNSET`	Start the studio on an interruptible instance.

Examples

  lightning studio connect

lightning studio cp

Copy a Studio file.

SOURCE: Source file to copy from. For Studio files, use the format lit://<owner>/<my-teamspace>/studios/<my-studio>/<filepath>, or lit:///studios/<my-studio>/<filepath> for the current teamspace.

DESTINATION: Destination file to copy to. For Studio files, use the same formats.

Usage:

lightning studio cp [OPTIONS] SOURCE DESTINATION

Arguments

Name	Type	Required	Description
`SOURCE`	`text`	yes	Source path in the Studio filesystem.
`DESTINATION`	`text`	yes	Destination path in the Studio filesystem.

Options

Option	Type	Required	Default	Description
`-r`, `--recursive`	—	no	`Sentinel.UNSET`	Copy directories recursively

Examples

  lightning studio cp source.txt lit://<owner>/<my-teamspace>/studios/<my-studio>/destination.txt
  lightning studio cp source.txt lit:///studios/<my-studio>/destination.txt
  lightning studio cp -r source_folder/ lit:///studios/<my-studio>/destination_folder/

lightning studio create

Create a new Studio.

Usage:

lightning studio create [OPTIONS]

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	The name of the studio to create. If not provided, a random name will be generated.
`--teamspace`	`TEXT`	no	`Sentinel.UNSET`	Override default teamspace (format: owner/teamspace)
`--cloud`	`TEXT`	no	`Sentinel.UNSET`	Cloud provider or cloud account to create the studio on. Defaults to teamspace default.
`--studio-type`	`TEXT`	no	`Sentinel.UNSET`	The base studio template name to use for creating the studio. Must be lowercase and hyphenated (use ‘-’ instead of spaces). Run ‘lightning base-studio list’ to see all available templates. Defaults to the first available template.
`--json`	—	no	—	Output the created Studio as JSON.

Examples

  lightning studio create

lightning studio delete

Delete a Studio.

Usage:

lightning studio delete [OPTIONS] NAME

Arguments

Name	Type	Required	Description
`NAME`	`text`	yes	No description provided.

Options

Option	Type	Required	Default	Description
`--teamspace`	`TEXT`	no	`Sentinel.UNSET`	Override default teamspace (format: owner/teamspace).
`--yes`, `-y`	—	no	—	Delete without prompting for confirmation.

lightning studio env

Manage Studio environment variables.

Usage:

lightning studio env [OPTIONS] COMMAND [ARGS]...

Commands

Command	Description
`delete`	Delete one directly configured Studio environment variable.
`list`	List directly configured Studio environment variables.
`set`	Set one Studio environment variable from KEY=VALUE.

lightning studio env delete

Delete one directly configured Studio environment variable.

Usage:

lightning studio env delete [OPTIONS] KEY

Arguments

Name	Type	Required	Description
`KEY`	`text`	yes	No description provided.

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	Studio to use. Falls back to the current Studio or configured default.
`--teamspace`	`TEXT`	no	—	The teamspace to use, as a bare name or an ‘owner/teamspace’ slug. Defaults to the current teamspace.
`--org`	`TEXT`	no	—	The organization owning the teamspace (if any). Defaults to the current organization.(DEPRECATED: Pass the owner as part of –teamspace instead, e.g. ‘–teamspace owner/teamspace’. This option will be removed in a future release.)
`--user`	`TEXT`	no	—	The user owning the teamspace (if any). Defaults to the current user.(DEPRECATED: Pass the owner as part of –teamspace instead, e.g. ‘–teamspace owner/teamspace’. This option will be removed in a future release.)
`--json`	—	no	—	Output as JSON.

lightning studio env list

List directly configured Studio environment variables.

Usage:

lightning studio env list [OPTIONS]

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	Studio to use. Falls back to the current Studio or configured default.
`--teamspace`	`TEXT`	no	—	The teamspace to use, as a bare name or an ‘owner/teamspace’ slug. Defaults to the current teamspace.
`--org`	`TEXT`	no	—	The organization owning the teamspace (if any). Defaults to the current organization.(DEPRECATED: Pass the owner as part of –teamspace instead, e.g. ‘–teamspace owner/teamspace’. This option will be removed in a future release.)
`--user`	`TEXT`	no	—	The user owning the teamspace (if any). Defaults to the current user.(DEPRECATED: Pass the owner as part of –teamspace instead, e.g. ‘–teamspace owner/teamspace’. This option will be removed in a future release.)
`--json`	—	no	—	Output as JSON.

lightning studio env set

Set one Studio environment variable from KEY=VALUE.

Usage:

lightning studio env set [OPTIONS] ASSIGNMENT

Arguments

Name	Type	Required	Description
`ASSIGNMENT`	`text`	yes	No description provided.

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	Studio to use. Falls back to the current Studio or configured default.
`--teamspace`	`TEXT`	no	—	The teamspace to use, as a bare name or an ‘owner/teamspace’ slug. Defaults to the current teamspace.
`--org`	`TEXT`	no	—	The organization owning the teamspace (if any). Defaults to the current organization.(DEPRECATED: Pass the owner as part of –teamspace instead, e.g. ‘–teamspace owner/teamspace’. This option will be removed in a future release.)
`--user`	`TEXT`	no	—	The user owning the teamspace (if any). Defaults to the current user.(DEPRECATED: Pass the owner as part of –teamspace instead, e.g. ‘–teamspace owner/teamspace’. This option will be removed in a future release.)
`--json`	—	no	—	Output as JSON.

lightning studio list

List Studios in a teamspace.

Usage:

lightning studio list [OPTIONS]

Options

Option	Type	Required	Default	Description
`--teamspace`	`TEXT`	no	`Sentinel.UNSET`	Override default teamspace (format: owner/teamspace)
`--all`	—	no	—	List all studios, not just the ones belonging to the authed user
`--sort-by`	`[name\|teamspace\|status\|machine\|cloud-account]`	no	—	the attribute to sort the studios by.
`--json`	—	no	—	Output as JSON.

Examples

  lightning studio list --teamspace owner/teamspace

lightning studio ls

List contents of a directory in Studio.

PATH: Studio path in the format lit://<owner>/<teamspace>/studios/<studio>/<directory-path>, or lit:///studios/<studio>/<directory-path> for the current teamspace.

Usage:

lightning studio ls [OPTIONS] PATH

Arguments

Name	Type	Required	Description
`PATH`	`text`	yes	Studio filesystem path to list.

Examples

  lightning studio ls lit://<owner>/<my-teamspace>/studios/<my-studio>/data
  lightning studio ls lit:///studios/<my-studio>/data

lightning studio open

Open a local file or folder in a Lightning Studio.

Usage:

lightning studio open [OPTIONS] [PATH]

Arguments

Name	Type	Required	Description
`PATH`	`path`	no	Local path to open in Lightning Studio.

Options

Option	Type	Required	Default	Description
`--teamspace`	`TEXT`	no	—	The teamspace to create the Studio in. Should be of format <OWNER>/<TEAMSPACE_NAME>. If not specified, tries to infer from the environment (e.g. when run from within a Studio.)
`--cloud`	`TEXT`	no	—	Cloud provider or cloud account to create the studio on.
`--resume`	—	no	`Sentinel.UNSET`	Resume an incomplete upload.
`--restart`	—	no	`Sentinel.UNSET`	Restart an incomplete upload.

lightning studio rm

Remove a Studio file or directory.

PATH: Studio path to remove. Use the format lit://<owner>/<my-teamspace>/studios/<my-studio>/<filepath>, or lit:///studios/<my-studio>/<filepath> for the current teamspace.

Usage:

lightning studio rm [OPTIONS] PATH

Arguments

Name	Type	Required	Description
`PATH`	`text`	yes	Studio filesystem path to remove.

Options

Option	Type	Required	Default	Description
`-r`, `--recursive`	—	no	`Sentinel.UNSET`	Remove directories recursively
`-f`, `--force`	—	no	`Sentinel.UNSET`	Ignore nonexistent files, never prompt

Examples

  lightning studio rm lit://<owner>/<my-teamspace>/studios/<my-studio>/file.txt
  lightning studio rm -r lit:///studios/<my-studio>/folder/

lightning studio ssh

SSH into a Studio.

Usage:

lightning studio ssh [OPTIONS]

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	Studio to use. Falls back to the current Studio or configured default.
`--teamspace`	`TEXT`	no	`Sentinel.UNSET`	Override default teamspace (format: owner/teamspace)
`--option`, `-o`	`TEXT`	no	`Sentinel.UNSET`	Additional options to pass to the SSH command. Can be specified multiple times.

Examples

  lightning studio ssh --name my-studio

lightning studio start

Start a Studio — a persistent GPU cloud workspace.

Usage:

lightning studio start [OPTIONS]

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	Studio to use. Falls back to the current Studio or configured default.
`--teamspace`	`OWNER/NAME`	no	`Sentinel.UNSET`	Override the default teamspace.
`--create`	—	no	`Sentinel.UNSET`	Create the Studio if it doesn’t exist.
`--machine`	`TYPE`	no	`Sentinel.UNSET`	Machine type to start on. Default: [bold #6FB3E8]CPU_4[/bold #6FB3E8]. [#6FB3E8]CPU[/#6FB3E8] · [#6FB3E8]T4[/#6FB3E8] · [#6FB3E8]L4[/#6FB3E8] · [#6FB3E8]L40S[/#6FB3E8] · [#6FB3E8]RTXP_6000[/#6FB3E8] · [#6FB3E8]A100[/#6FB3E8] · [#6FB3E8]H100[/#6FB3E8] · [#6FB3E8]H200[/#6FB3E8] · [#6FB3E8]B200[/#6FB3E8] x1-8 · full list: [bold #a78bfa]lightning machine list[/bold #a78bfa]
`--gpus`	`TYPE:COUNT`	no	`Sentinel.UNSET`	GPUs to attach, e.g. [bold #6FB3E8]L4:4[/bold #6FB3E8].
`--interruptible`	—	no	`Sentinel.UNSET`	Use a cheaper interruptible (spot) instance.
`--cloud`	`TEXT`	no	`Sentinel.UNSET`	Cloud provider or account. Default: teamspace. (with –create)

Examples

  lightning studio start --name my-studio --machine A100 --create

lightning studio stop

Stop a Studio.

Usage:

lightning studio stop [OPTIONS]

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	Studio to use. Falls back to the current Studio or configured default.
`--teamspace`	`TEXT`	no	`Sentinel.UNSET`	Override default teamspace (format: owner/teamspace)
`--json`	—	no	—	Output as JSON.

Examples

  lightning studio stop --name my-studio

lightning studio switch

Switch a Studio to a different machine type.

Usage:

lightning studio switch [OPTIONS]

Options

Option	Type	Required	Default	Description
`--name`	`TEXT`	no	`Sentinel.UNSET`	Studio to use. Falls back to the current Studio or configured default.
`--teamspace`	`TEXT`	no	`Sentinel.UNSET`	Override default teamspace (format: owner/teamspace)
`--machine`	`[CPU_SMALL\|CPU\|CPU_X_2\|CPU_X_4\|CPU_X_8\|CPU_X_16\|DATA_PREP\|DATA_PREP_MAX\|DATA_PREP_ULTRA\|T4_SMALL\|T4\|T4_X_2\|T4_X_4\|T4_X_8\|L4\|L4_X_2\|L4_X_4\|L4_X_8\|L40S\|L40S_X_2\|L40S_X_4\|L40S_X_8\|RTXP_6000\|RTXP_6000_X_2\|RTXP_6000_X_4\|RTXP_6000_X_8\|A100\|A100_X_2\|A100_X_4\|A100_X_8\|A100_40GB\|A100_40GB_X_2\|A100_40GB_X_4\|A100_40GB_X_8\|A100_80GB\|A100_80GB_X_2\|A100_80GB_X_4\|A100_80GB_X_8\|H100\|H100_X_2\|H100_X_4\|H100_X_8\|H200\|H200_X_2\|H200_X_4\|H200_X_8\|B200\|B200_X_8]`	no	`Sentinel.UNSET`	The machine type to switch the studio to.
`--interruptible`	—	no	`Sentinel.UNSET`	Switch the studio to an interruptible instance.

Was this page helpful?