- Verify Your Starport Version
- Installing Starport
- Upgrading Your Starport Installation
- Installing Starport on macOS with Homebrew
- Build from source
# Install Starport
You can run Starport (opens new window) in a web-based Gitpod IDE or you can install Starport on your local computer.
Be sure you have met the prerequisites before you install and use Starport.
# Operating Systems
Starport is supported for the following operating systems:
- Windows Subsystem for Linux (WSL)
Starport is written in the Go programming language. To use Starport on a local system:
- Install Go (opens new window) (version 1.16 or higher)
- Ensure the Go environment variables are set properly (opens new window) on your system
# Verify Your Starport Version
To verify the version of Starport you have installed, run the following command:
# Installing Starport
To install the latest version of the
starport binary use the following command.
This command invokes
curl to download the install script and pipes the output to
bash to perform the installation. The
starport binary is installed in
To learn more or customize the installation process, see Starport installer docs (opens new window) on GitHub.
# Write Permission
Starport installation requires write permission to the
/usr/local/bin/ directory. If the installation fails because you do not have write permission to
/usr/local/bin/, run the following command:
Then run this command to move the
starport executable to
# Upgrading Your Starport Installation
Before you install a new version of Starport, remove all existing Starport installations.
To remove the current Starport installation:
- On your terminal window, press
Ctrl+Cto stop the chain that you started with
starport chain serve.
- Remove the Starport binary with
rm $(which starport). Depending on your user permissions, run the command with or without
- Repeat this step until all
starportinstallations are removed from your system.
After all existing Starport installations are removed, follow the Installing Starport with cURL instructions. For details on version features and changes, see the changelog.md (opens new window) in the repo.
# Installing Starport on macOS with Homebrew
Using brew to install Starport is supported only for macOS machines without the M1 chip.
To install Starport on macOS machines with the M1 chip, use the
curl command as described in Installing Starport.
# Build from source
- Verify the prerequisites.
- To setup a local development environment, install Starport locally on your computer.
- Install Starport by fetching the binary using cURL, Homebrew, or by building from source.
- The latest version is installed by default. You can install previous versions of the precompiled
- Stop the chain and remove existing versions before installing a new version.