Installing Caplin CLI

Note: this documentation is for a beta release of Caplin Trader 5. Features may change before the final release.

This page provides instructions for installing Caplin CLI, the Caplin Trader 5 command-line interface.

Use Caplin CLI to create a development workspace and to create scaffolding for new applications and components.

Contents:

Requirements

Caplin CLI has the following requirements:

Node.js version

Caplin Trader's build stack requires Node.js 7 64-bit or higher.

Caplin Trader 5 is not yet compatible with npm 5, which is distributed with Node.js 8. If you are using Node.js 8, downgrade your version of npm to 4.

Minimum recommend RAM

For Windows 10 developer machines, we recommend a minimum of 4GB of RAM.

Network connectivity

Caplin Trader's build stack requires Internet access to the following domains:

  • The npm registry (registry.npmjs.org)
  • GitHub (github.com)
Note: the npm package manager does not have built-in support for Microsoft NTLM authentication. If you access the Internet via a proxy server that uses NTLM authentication, then configure npm to use a transparent proxy (if available) or configure npm to use an intermediate local proxy that appends your NTLM credentials to npm's requests.

Installing Caplin CLI

To install Caplin CLI, run the command below:

npm install -g caplin-cli

Updating Caplin CLI

To upgrade an existing installation of Caplin CLI, run the command below:

npm update -g caplin-cli