Files
solana/docs/src/cli/install-solana-cli-tools.md
2020-03-26 14:39:32 -07:00

3.8 KiB

Installing Solana

Install the Solana release LATEST_SOLANA_RELEASE_VERSION on your machine by running:

curl -sSf https://raw.githubusercontent.com/solana-labs/solana/LATEST_SOLANA_RELEASE_VERSION/install/solana-install-init.sh | sh -s - LATEST_SOLANA_RELEASE_VERSION

If you are connecting to a different testnet, you can replace LATEST_SOLANA_RELEASE_VERSION with the release tag matching the software version of your desired testnet, or replace it with the named channel stable, beta, or edge.

The following output indicates a successful update:

looking for latest release
downloading LATEST_SOLANA_RELEASE_VERSION installer
Configuration: /home/solana/.config/solana/install/config.yml
Active release directory: /home/solana/.local/share/solana/install/active_release
* Release version: LATEST_SOLANA_RELEASE_VERSION
* Release URL: https://github.com/solana-labs/solana/releases/download/LATEST_SOLANA_RELEASE_VERSION/solana-release-x86_64-unknown-linux-gnu.tar.bz2
Update successful

After a successful install, solana-install update may be used to easily update the cluster software to a newer version at any time.

Download Prebuilt Binaries

If you would rather not use solana-install to manage the install, you can manually download and install the binaries.

Linux

Download the binaries by navigating to https://github.com/solana-labs/solana/releases/latest, download solana-release-x86_64-unknown-linux-gnu.tar.bz2, then extract the archive:

tar jxf solana-release-x86_64-unknown-linux-gnu.tar.bz2
cd solana-release/
export PATH=$PWD/bin:$PATH

macOS

Download the binaries by navigating to https://github.com/solana-labs/solana/releases/latest, download solana-release-x86_64-apple-darwin.tar.bz2, then extract the archive:

tar jxf solana-release-x86_64-apple-darwin.tar.bz2
cd solana-release/
export PATH=$PWD/bin:$PATH

Build From Source

If you are unable to use the prebuilt binaries or prefer to build it yourself from source, navigate to https://github.com/solana-labs/solana/releases/latest, and download the Source Code archive. Extract the code and build the binaries with:

./scripts/cargo-install-all.sh .
export PATH=$PWD/bin:$PATH

You can then run the following command to obtain the same result as with prebuilt binaries:

solana-install init

Choosing a Cluster

Solana maintains several clusters, each featuring a Solana-owned validator that serves as an entrypoint to the cluster.

Current cluster entrypoints:

  • Devnet: devnet.solana.com
  • Tour de SOL: tds.solana.com

Application developers should target Devnet. Key differences between Devnet and what will be Mainnet:

  • Devnet tokens are not real
  • Devnet includes a token faucet for application testing
  • Devnet may be subject to ledger resets
  • Devnet typically runs a newer software version than mainnet
  • Devnet may be maintained by different validators than mainnet

Configure the Command-line

You can check what cluster the Solana CLI is currently targeting by running the following command:

solana config get

Use the solana config set command to target a different cluster. For example, for Devnet, use:

solana config set --url http://devnet.solana.com

Ensure Versions Match

Though not strictly necessary, the CLI will generally work best when its version matches the software version running on the cluster. To get the CLI version, run:

solana --version

To get the cluster version, run:

solana cluster-version

Ensure the CLI version is greater than or equal to the cluster version.