WarpJS SDK Documentation | The JavaScript Full Stack Suite

WarpJS SDK Documentation | The JavaScript Full Stack Suite

›API Reference

Getting Started

  • Quick Start

JavaScript Virtual Cloud

  • JavaScript Virtual Cloud Introduction
  • Unified developer workflow
  • WarpJS SDK Installation
  • Build, run and develop warped modules
  • Deploy warped modules
  • Deploy static public assets
  • Glossary

Use a warped module

  • From browser using HTML
  • From browser using a builder
  • From Node.js
  • Frameworks integration

API Reference

  • Requirements
  • CLI
  • Configuration file
  • Engine
  • Infrastructure support

WarpJS Command-line Interface

Install the CLI

To install the CLI, open your terminal in a Node.js project and install with npm:

npm install warp

or to install it globally:

npm install -g warp

Alternatively you can launch a command without installing warp, by using npx:

npx warp [command]

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.

The --force option disable the interactivity. With this option, project or environment will be automatically created with the given name if the don't exist.

In a non interactive shell, a command might fail without the --force option if all projects and environments specified doesn't exists.

Server configuration

Options can also be omitted if you use a server configuration file.

The CLI overrides values from a server configuration file.

See documentation here.

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

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

Login

login

Log into your ScaleDynamics account.

npx warp login [e-mail] [org]

Create an account on your ScaleDynamics Console.

Arguments

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

Options

OptionDescriptionDefault
-p, --password <password>passwordinteractive
--api-key <api-key>api-key

Warning Useful if you want to use a CI/CD but be careful, the password 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

Dev

Build project, launch emulator and watch for changes in your project.

npx warp dev [options] [server-config...]

Arguments

ArgumentDescription
[server-config...]path to one or multiple configuration file

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
-o, --output <format>:<path>format (umd or node-module) and path of outputfrom server configuration file
--arg <key>=<value>set a config argument, repeatable
--forcecreate the given project if it doesn't exist

See output documentation here.

Build

Generate the client.

npx warp build [options] [server-config...]

Arguments

ArgumentDescription
[server-config...]path to one or multiple configuration file

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
-o, --output <format>:<path>format (umd or node-module) and path of outputfrom server configuration file
--arg <key>=<value>set a config argument, repeatable
--forcecreate the given project if it doesn't exist

See output documentation here.

Emulator

run

Launch an emulator.

npx warp emulator run [options] [server-config...]

Arguments

ArgumentDescription
[server-config...]path to one or multiple configuration file

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
--arg <key>=<value>set a config argument, repeatable
--forcecreate the given project if it doesn't exist
-p, --port <number>use custom port number3192, or from server configuration file

stop

Stop an emulator.

npx warp emulator stop [server-config...]

Arguments

ArgumentDescription
[server-config...]path to one or multiple configuration file

Options

OptionDescriptionDefault
--arg <key>=<value>set a config argument, repeatable

Deploy

Deploy the serverless functions and assets of your project.

npx warp deploy [options] [server-config...]

Arguments

ArgumentDescription
[server-config...]path to one or multiple configuration file

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
--name <name>deployment namerandomly generated
--env <name>environment nameselected environment or interactive
--arg <key>=<value>set a config argument, repeatable
--forcecreate the given project and environment if they don't exist

Project

create

Create a project.

npx warp project create [name]

Arguments

ArgumentDescriptionDefault
[name]project nameinteractive

delete

Delete a project.

npx warp project delete [name]

Arguments

ArgumentDescriptionDefault
[name]project nameinteractive

deselect

Remove the selected project.

npx warp project deselect

select

Select a project.

npx warp project select [name]

Arguments

ArgumentDescriptionDefault
[name]project nameinteractive

info

Print info on project.

npx warp project info [options]

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive

list

List projects.

npx warp project list

Environment

create

Create an environment.

npx warp env create [options] [name]

Arguments

ArgumentDescriptionDefault
[name]environment nameinteractive

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive

delete

Delete an environment.

npx warp env delete [options] [name]

Arguments

ArgumentDescriptionDefault
[name]environment nameinteractive

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
--hostname <fully-qualified-hostname>fully qualified hostname for hosting URLinteractive

deselect

Remove the selected environment.

npx warp env deselect

select

Select an environment.

npx warp env select [options] [name]

Arguments

ArgumentDescriptionDefault
[name]environment nameinteractive

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive

info

Print info on environment.

npx warp env info [options]

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
--env <name>environment nameselected environment or interactive

list

List environments.

npx warp env list [options]

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive

Deployment

info

Print info on deployment.

npx warp deployment info [name] [options]

Arguments

ArgumentDescriptionDefault
[name]deployment name<interactive>

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
--env <name>environment nameselected environment or interactive

list

List deployments.

npx warp deployment list [options]

Options

OptionDescriptionDefault
--project <name>project nameselected project or interactive
--env <name>environment nameselected environment or interactive

Version

Print version.

npx warp version
← RequirementsConfiguration file →
  • Install the CLI
  • Interactivity
  • Server configuration
  • Help
  • Login
    • login
    • logout
    • whoami
  • Dev
  • Build
  • Emulator
    • run
    • stop
  • Deploy
  • Project
    • create
    • delete
    • deselect
    • select
    • info
    • list
  • Environment
    • create
    • delete
    • deselect
    • select
    • info
    • list
  • Deployment
    • info
    • list
  • Version
WarpJS SDK Documentation | The JavaScript Full Stack Suite
Docs
Getting StartedAPI Reference
WarpJS
WebsiteTwitterLinkedIn
More
npmGitHubAbout Us
© ScaleDynamics - 2021