SDK

Our SDK provides you a CLI you can use to manage projects, environments, runners, and containers.

It is available on desktop/laptop (windows, mac, linux) and compatible with any IDE, bundler, static site generators, cloud-native web frameworks, CI/CDs, APIs, databases, so it's compatible with what you already use.

Requirements

To use our SDK, you need Node.js installed on your computer with the version 12 or higher. Look here (opens in a new tab) to install it.

Installation

Global installation

The preferred way to install the SDK is to install it globally for all users. After that you can use the warp command as another terminal command.

npm install -g warp

This command may need to be launched with root priviledged on Linux system. In that case, use the command su or sudo.

Per user installation

On Linux or Mac system, you can also install the SDK in your home directory, without root access, by using the following command:

npm install --prefix=$HOME -g warp

Warp will be installed in the directory bin inside your home directory or any other directory set by the option --prefix. If not already done, you need to update your PATH variable to access this directory in your terminal, or in any startup script (e.g. .bashrc) with:

export PATH="$HOME/bin:$PATH"

See this blog (opens in a new tab) to know how to do that according to your shell.

Per node.js installation

If you work on a node.js project, another way is to install it locally in your working node.js project directory. Then you'll use npx warp ... to run commands.

npm install warp

Without installation

At last you can use the SDK without installation using the npx warp ... command.

Get a ScaleDynamics organization

If you don't have one, you can signup an account and create an new organization (sign up here), or start a one month free trial (trial here), no credit card required.

Developer session

To enter a developer session. You have to use your ScaleDynamics credentials to be identified using:

npx warp login

Usage

To get all other available commands you can use warp help. Please refer to the SDK command line documentation for details and supported options for each one.