Skip to main content

Installation

Protostar is easy to install on Linux and Mac systems. In this section, we will walk through the process of installing and upgrading Protostar.

Requirements​

To use Protostar with Cairo 1, you need Scarb installed and added to your PATH environment variable.

Linux and Mac​

  1. Open a terminal and run the following command:
curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash
  1. Close and reopen the terminal.
  2. To check if the Protostar is installed correctly, run protostar -v.

Specifying version​

If you want to install a specific version of Protostar, run the following command with the desired version number:

curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash -s -- -v 0.3.2

Windows Compatibility​

Protostar is not currently supported on Windows.

Upgrading Protostar​

To upgrade Protostar, run:

protostar upgrade

Protostar will inform you when a new version is available.

How to build Protostar from source code​

If you are unable to install Protostar using the instructions above, you can try building it from the source code as follows:

  1. Set up a development environment.
  2. Run poe build. This will create a dist directory.
  3. Move the dist directory to the desired location (e.g. ~/.protostar).
  4. Add DESIRED_LOCATION/dist/protostar to the PATH.