Install Adapt

Requirements

To install and use Adapt, you must have both of the following:

Requirement	Installation Instructions
Node.js verson 10	Installing Node and npm
Yarn Package Manager	Installing yarn

Additionally, this Getting Started Guide also requires Docker. You'll need one of the following:

Requirement	Installation Instructions
A Linux system with Docker	Installing Docker on Linux
A MacOS system with Docker Desktop for Mac	Installing Docker Desktop for Mac

note

If you're using Docker on Linux, you'll need to either run all docker commands as superuser (root) or ensure your user is part of the docker group.

For instructions and more information, see the Docker Linux post-install instructions.

Docker is correctly installed if the command docker ps does not show any errors.

Lastly, certain commands assume you're using the bash shell. If you use a different shell, you may need to adjust some commands slightly.

Installing Adapt

To install the adapt CLI globally:

npm install -g @adpt/cli

note

Depending on how your npm installation is set up, you may need root or administrator privileges to install an npm module globally.

If you get an EACCES error from npm install, use the npx instructions below or retry the command with administrator privileges (e.g. with sudo).

Alternately, if you'd rather not install Adapt globally, you can run Adapt using npx (click to expand)

As an alternative to installing adapt globally, you can use npx instead. To use Adapt via npx, any time you see an adapt CLI command in this guide, simply substitute npx @adpt/cli instead of adapt. For example, if this guide asks you to run this command:

adapt new blank

You would instead type:

npx @adpt/cli new blank

The rest of this guide will assume you have installed adapt globally using npm install -g.