SDK command line

We present below the different command lines provided by our SDK.

All relative paths from the CLI are relative to the directory the command was launched in.

Interactivity

The CLI is interactive by default. If a mandatory option is missing, then you will be asked to input its value. You will also be asked confirmation before some operations.

Options can be omitted if you use a configuration file. Note that the CLI overrides values from a configuration file. See Configuration file.

Help

To get a list of commands, run:

npx warp help
npx warp -h

To get details about a command's options, run:

npx warp help [command]
npx warp <command> -h

General options

Option	Description	Default
--api-key <api-key>	temporarily logs you with an api-key to execute a command.
--send-report <level>	send report to ScaleDynamics. Available levels : 'none', 'error', 'trace', 'full'

Report levels:

• none: None
• error: Display only the error related info inside warp command line
• trace: Same as error level with the addition of all interactions between the CLI and ScaleDynamics server, and console output and input.
• full: Same as trace level with the addition of the CLI arguments and everything about the environment variables starting with WARP_

Working session

login

Log into your ScaleDynamics account.

npx warp login [e-mail] [org]

Create an account on your ScaleDynamics Console.

Arguments

Argument	Description	Default
[e-mail]	e-mail	interactive
[org]	organization you want to log into (only available if you specified an e-mail)	interactive

Options

Option	Description	Default
-p, --password <password>	password	interactive
--api-key <api-key>	api-key

Warning Useful if you want to use a CI/CD but be careful, the password or the api-key can be read in plain text in different systems.

logout

Log out of your ScaleDynamics account.

npx warp logout

whoami

Print your credential info.

npx warp whoami

whereami

Print your working session project and environment you selected.

npx warp whereami

project

create

Create a project.

npx warp project create [name]

Arguments

Argument	Description	Default
[name]	project name	interactive

delete

Delete a project.

npx warp project delete [name] [options]

Arguments

Argument	Description	Default
[name]	project name	interactive

Options

Option	Description	Default
-y, --yes	delete the given project without confirmation

select

Select a project.

npx warp project select [name]

Arguments

Argument	Description	Default
[name]	project name	interactive

deselect

Remove the selected project.

npx warp project deselect

info

Print info on project.

npx warp project info [options]

Options

Option	Description	Default
--project <name>	project name	selected project or interactive

list

List projects.

npx warp project list

env

create

Create an environment.

npx warp env create [name] [options]

Arguments

Argument	Description	Default
[name]	environment name	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive

delete

Delete an environment.

npx warp env delete [name] [options]

Arguments

Argument	Description	Default
[name]	environment name	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
-y, --yes	delete the given environment without confirmation

select

Select an environment.

npx warp env select [name] [options]

Arguments

Argument	Description	Default
[name]	environment name	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive

deselect

Remove the selected environment.

npx warp env deselect

info

Print info on environment.

npx warp env info [options]

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

list

List environments.

npx warp env list [options]

Options

Option	Description	Default
--project <name>	project name	selected project or interactive

runner

set

Set a runner on an environment

npx warp env runner set [config-id] [runner] [options]

Arguments

Argument	Description	Default
[config-id]	deployment configuration ID	interactive
[runner]	runner name	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

Unless you customize it in the warp configuration, when deploying, the service name will be used as deployment configuration ID by default. See container, server and hosting configuration.

volume

link

Link a service volume ID to a volume

npx warp env volume link [service-name] [service-volume-id] [volume-name] [options]

Arguments

Argument	Description	Default
[service-name]	service name	interactive
[service-volume-id]	service volume ID	interactive
[volume-name]	volume name	interactive

See service-volume-id configuration.

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

unlink

unlink a service volume ID

npx warp env volume unlink [service-name] [service-volume-id] [options]

Arguments

Argument	Description	Default
[service-name]	service name	interactive
[service-volume-id]	service volume ID	interactive

See service-volume-id configuration.

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

base-url

add

Add a base URL for the environment

npx warp env base-url add [id] [hostname] [options]

Arguments

Argument	Description	Default
[id]	base URL ID	interactive
[hostname]	fully qualified hostname for base URL	interactive or randomly generated if non-interactive

Unless you customize it in the warp configuration, when deploying, the service name will be used as base URL ID by default. See container, server and hosting configuration.

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

auth

Manage authentication in your environment. By default, no authentication is required in an environment. See authorization documentation here

basic

See basic authentication here

add

Add an authorized user.

npx warp env auth basic add [id] [user] [options]

Arguments

Argument	Description	Default
[id]	base URL ID	interactive
[user]	user name	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive
-p, --password <password>	password	interactive

revoke

Remove an authorized user.

npx warp env auth basic revoke [id] [user] [options]

Arguments

Argument	Description	Default
[id]	base URL ID	interactive
[user]	user name	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

delete

Remove the basic authentication.

npx warp env auth basic delete [id] [options]

Arguments

Argument	Description	Default
[id]	base URL ID	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

deploy

Build and deploy one or multiple containers.

npx warp deploy [options] [config-file...] [directories...]

Arguments

Argument	Description
[directories...]	path to one or multiple container directory
[config-file...]	path to one or multiple configuration file

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--name <name>	deployment name	randomly generated
--env <name>	environment name	selected environment or interactive
--arg <key>=<value>	set a config argument, repeatable
-v, --verbose	display the list of files uploaded and not uploaded, and the source of the filters used for uploading

deployment

delete

Delete a deployment.

npx warp deployment delete [name] [options]

Arguments

Argument	Description	Default
[name]	deployment name	interactive

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive
-y, --yes	delete the given deployment without confirmation

info

Print info on deployment.

npx warp deployment info [name] [options]

Arguments

Argument	Description	Default
[name]	deployment name	<interactive>

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

list

List deployments.

npx warp deployment list [options]

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive

logs

Print the logs of your deployed services.

npx warp deployment logs [name] [options]

Arguments

Argument	Description	Default
[name]	deployment name	<interactive>

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive
--follow	monitor the logs and display each logs as they are added
--timestamps [format]	show the reception timestamps of the logs by warp, can be in ISO 8601 format if iso is specified
--runner	show runner name
--service <names>	list of services to display, separated by a comma
--since <time>	show logs from the given date or time
--until <time>	show logs before the given date or time
--tail <number>	only display the last number of lines
--level <levels>	list of levels to display, separated by a comma
--no-color	disable color usage
--raw	output raw log messages (without timestamps or level) to stdout or stderr according to their level

The --since and --until options takes either an ISO 8601 date, a UNIX timestamp (number of milliseconds elapsed since January 1, 1970 00:00:00 UTC), or a duration string.

The ISO 8061 date format corresponds to the YYYY-MM-DDTHH:mm:ss.sssZ format where:

• YYYY is the year.
• MM is the month of the year.
• DD is the day of the month.
• T indicates the beginning of the time element, and thus appears literally in the string.
• HH indicates the number of hours, from 00 to 24.
• mm indicates the number of minutes.
• ss indicates the number of seconds.
• sss indicates the number of milliseconds.
• Z indicates the UTC offset representation specified as "Z" (for UTC with no offset) or an offset of either "+" or "-" followed by a time expression HH:mm (indicating local time ahead of or behind UTC, respectively).

See here for more information on the date format.

A duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix. Valid time units are:

Unit	Diminutive
milliseconds	ms
seconds	s or sec
minutes	m or min
hours	h or hr
days	d
weeks	w or wk
months	none

By default the --timestamps option display a human-readable date. If you want a ISO 8601 date, you can add the format like this: --timestamps iso.

exec

Execute a command in a running container.

npx warp deployment exec [deployment-name] [service-name] [options] -- [command...]

Arguments

Argument	Description	Default
[deployment-name]	deployment name	<interactive>
[service-name]	service name	<interactive>
[command...]	command with its arguments and options	sh

Warning You need to use -- before the command argument. Be careful, using -- will disable any following option. Enter all options before --.

Options

Option	Description	Default
--project <name>	project name	selected project or interactive
--env <name>	environment name	selected environment or interactive
--workdir <path>	absolute path inside the container of the command working directory

runner

A runner path is a path to an organization, a project or an environment as follows : /[project-name]/[environment-name]. The path to your organization is /. All runners are attached to an organization, a project or an environment, so you can use this path to select where to create your runner or to filter runners in the commands. A runner model use the same type of path.

create

Create a runner.

npx warp runner create [options] [name] -- [<path>=<value>...]

Arguments

Argument	Description	Default
[name]	runner name	interactive
[<path>=<value>...]	variable to set for the runner model (repeatable)	interactive

You can find the list of available variables for a model with the model info command.

Warning You need to use -- before any <path>=<value> argument. Be careful, using -- will disable any following option. Enter all options before --.

Options

Option	Description	Default
--path	runner path	interactive
--model	model name	interactive

You can find the list of available models with the model list command.

delete

Delete a runner.

npx warp runner delete [name] [options]

Arguments

Argument	Description	Default
[name]	runner name	interactive

Options

Option	Description	Default
--path	runner path	interactive
-y, --yes	delete the given runner without confirmation
--force	force deletion of runner

Warning With the --force option the runner will be deleted. Even if an error occurs it will be deleted from the ScaleDynamics platform. All non-deprovisionned resources in your cloud service provider will become stale resources.

info

Print info on a runner.

npx warp runner info [options]

Options

Option	Description	Default
--path <name>	runner path	interactive

list

List runners.

npx warp runner list [options]

Options

Option	Description	Default
--path <name>	runner path	/

exec

Execute a command on a runner.

npx warp runner exec [name] [options] -- [command...]

Arguments

Argument	Description	Default
[name]	runner name	<interactive>
[command...]	command with its arguments and options	sh

Warning You need to use -- before the command argument. Be careful, using -- will disable any following option. Enter all options before --.

Options

Option	Description	Default
--path <name>	runner path	/

model

list

List available runner models.

npx warp runner model list [options]

Options

Option	Description	Default
--path <name>	model path	/
--output-format <format>	output format. Available formats: human, json, yaml, csv	human

info

Print info on runner model.

npx warp runner model info [name] [options]

Arguments

Argument	Description	Default
[name]	model name

Options

Option	Description	Default
--path <name>	model path	/

volume

A volume path is a path to an organization, a project or an environment as follows : /[project-name]/[environment-name]. The path to your organization is /. All volumes are attached to an organization, a project or an environment, so you can use this path to select where to create your volume or to filter volumes in the commands. A volume model use the same type of path.

create

Create a volume.

npx warp volume create [options] [name] -- [<path>=<value>...]

Arguments

Argument	Description	Default
[name]	volume name	interactive
[<path>=<value>...]	variable to set for the volume model (repeatable)	interactive

You can find the list of available variables for a model with the model info command.

Warning You need to use -- before any <path>=<value> argument. Be careful, using -- will disable any following option. Enter all options before --.

Options

Option	Description	Default
--path	volume path	interactive
--model	model name	interactive

You can find the list of available models with the model list command.

delete

Delete a volume.

npx warp volume delete [name] [options]

Arguments

Argument	Description	Default
[name]	volume name	interactive

Options

Option	Description	Default
--path	volume path	interactive
-y, --yes	delete the given volume without confirmation

list

List available volumes.

npx warp volume list [options]

Options

Option	Description	Default
--path <name>	volume path	/

info

Print info on volume.

npx warp volume info [name] [options]

Arguments

Argument	Description	Default
[name]	volume name

Options

Option	Description	Default
--path <name>	volume path	/

model

list

List available volume models.

npx warp volume model list [options]

Options

Option	Description	Default
--path <name>	model path	/
--output-format <format>	output format. Available formats: human, json, yaml, csv	human

info

Print info on volume model.

npx warp volume model info [name] [options]

Arguments

Argument	Description	Default
[name]	model name

Options

Option	Description	Default
--path <name>	model path	/

connector

list

List available connectors.

npx warp connector list [options]

Options

Option	Description	Default
--path <name>	connector path	/

info

Print info on connector.

npx warp connector info [name] [options]

Arguments

Argument	Description	Default
[name]	connector name

Options

Option	Description	Default
--path <name>	connector path	/

operation

wait

Wait for one or multiples operations to finish

npx warp operation wait <id...>

Arguments

Argument	Description	Default
<id...>	operation id

info

Print info on operation

npx warp operation info <id>

Arguments

Argument	Description	Default
<id>	operation id

config

A path to a project, an environment or a deployment is as follows : /[project-name]/[environment-name]/[deployment-name]. The path to your organization is /.

get

Get the value of a property in the configuration

npx warp config get <config-path> [options]

Arguments

Argument	Description	Default
<config-path>	path in the config

Options

Option	Description	Default
--path	path to a project/environment/deployment	interactive

default

Sets the property in the configuration if no value is already defined by a parent element of your path. For example, if you are modifying the configuration of an environment, a parent would be its project or its organization.

npx warp config default <config-path> <value> [options]

Arguments

Argument	Description	Default
<config-path>	path in the config
<value>	value

Options

Option	Description	Default
--path	path to a project/environment/deployment	interactive
--input-format <format>	input format. Available formats: string, json	string

override

Override the property in the configuration

npx warp config override <config-path> <value> [options]

Arguments

Argument	Description	Default
<config-path>	path in the config
<value>	value

Options

Option	Description	Default
--path	path to a project/environment/deployment	interactive
--input-format <format>	input format. Available formats: string, json	string

erase

Erase the property in the configuration

npx warp config override <config-path> [options]

Arguments

Argument	Description	Default
<config-path>	path in the config

Options

Option	Description	Default
--path	path to a project/environment/deployment	interactive

revoke

Revoke a modification of the property in the configuration

npx warp config revoke <config-path> [options]

Arguments

Argument	Description	Default
<config-path>	path in the config

Options

Option	Description	Default
--path	path to a project/environment/deployment	interactive

version

Print version.

npx warp version