Command reference | DS Plane CLI

Run dsplane --help for the installed version’s command list. Run dsplane <command> --help for command-specific help.

Global command

dsplane [command]

Option	Description
`-h`, `--help`	Show usage and exit.
`-v`, `--version`	Print the CLI version.

Running dsplane without a command opens interactive mode.

Shared Dev Space options

The ssh, start, stop, and delete commands require:

Option	Description
`-l`, `--landscape <URL>`	Full URL of the target landscape.
`-d`, `--devspace <name>`	Display name of the target Dev Space.

`dsplane ssh`

Connect stdin and stdout to the Dev Space SSH service:

dsplane ssh -l https://example.applicationstudio.cloud.sap -d MyDevSpace

See SSH access for OpenSSH prerequisites and saved aliases.

`dsplane start`

Start a stopped Dev Space:

dsplane start -l https://example.applicationstudio.cloud.sap -d MyDevSpace

`dsplane stop`

Stop a running Dev Space:

dsplane stop -l https://example.applicationstudio.cloud.sap -d MyDevSpace

`dsplane delete`

Delete a Dev Space:

dsplane delete -l https://example.applicationstudio.cloud.sap -d MyDevSpace

Deleting a Dev Space removes the remote environment. Confirm the landscape and display name before running this command.

`dsplane create`

Create a Dev Space:

dsplane create \
  --landscape https://example.applicationstudio.cloud.sap \
  --name MyDevSpace \
  --type FULL_STACK \
  --extension extension-one \
  --extension extension-two

Option	Required	Description
`-l`, `--landscape <URL>`	Yes	Full URL of the target landscape.
`-n`, `--name <name>`	Yes	Display name for the Dev Space.
`-t`, `--type <type>`	Yes	Dev Space type identifier returned by `extensions`.
`-e`, `--extension <extensions...>`	No	One or more additional extension identifiers.

`dsplane extensions`

List Dev Space types and extensions exposed by a landscape:

dsplane extensions \
  --landscape https://example.applicationstudio.cloud.sap

Option	Required	Description
`-l`, `--landscape <URL>`	Yes	Full URL of the target landscape.
`-t`, `--type <type>`	No	Dev Space type whose additional extensions to list.
`-j`, `--json`	No	Write JSON instead of formatted terminal output.

`dsplane ide`

Open a Dev Space in a local IDE:

dsplane ide \
  --landscape https://example.applicationstudio.cloud.sap \
  --devspace MyDevSpace \
  --ide vscode

Option	Required	Description
`-o`, `--options`	No	List recognized IDE identifiers and exit.
`-l`, `--landscape <URL>`	For connection	Full URL of the target landscape.
`-d`, `--devspace <name>`	For connection	Display name of the target Dev Space.
`-i`, `--ide <ide>`	For connection	IDE identifier to open.

See IDE integration for the currently implemented IDEs.