Skip to content
🎉 Welcome to the new Aptos Docs! Click here to submit an issue.
BuildCLIInstallationMac

Install the Aptos CLI on Mac

For Mac, the easiest way to install the Aptos CLI is with the package manager brew.

Installation

Ensure you have brew installed https://brew.sh/.

Open a new terminal and enter the following commands.

Terminal
brew update
brew install aptos

Open another terminal and run aptos help to verify the CLI is installed.

Terminal
aptos help
⚠️

If brew does not work for you, you can try the steps here: Install via Script or Install via Pre-Compiled Binaries.)

Upgrading the CLI

Upgrading the CLI with brew just takes 2 commands:

Terminal
brew update
brew upgrade aptos

Install via Script

In the terminal, use one of the following commands:

Terminal
curl -fsSL "https://aptos.dev/scripts/install_cli.sh" | sh

Or use the equivalent wget command:

Terminal
wget -qO- "https://aptos.dev/scripts/install_cli.sh" | sh

(Optional) It can be helpful to add the Aptos CLI to a folder in your PATH, or to add it to your PATH directly.

  • The steps to add a folder to your PATH are shell dependent.
  • You can run echo $SHELL to print the default shell for your machine, then google specific steps to add a folder to your PATH for that shell.

Verify the script is installed by opening a new terminal and running aptos help

  • You should see a list of commands you can run using the CLI.
  • In the future, this is a helpful resource to learn exactly how each command works.
ℹ️

If you would like to update the Aptos CLI to the latest version, you can run aptos update.

Install via Pre-Compiled Binaries (Backup Method)

Go to the Aptos CLI release page.

Click the “Assets” expandable menu for the latest release to see the pre-compiled binaries.

Download the zip file for macOS.

  1. It’ll have a name like: aptos-cli-<version>-macOS-x86_64.zip or aptos-cli-<version>-macOS-arm64.zip.
  2. Make sure you choose the right zip file for your computer architecture (x86_64 for Intel / AMD or arm64 for ARM).
  3. You will likely have to dismiss warnings that this is a suspicious file when downloading.

Unzip the downloaded file.

Move the extracted Aptos binary file into your preferred folder.

Open a terminal and navigate to your preferred folder.

Make ~/aptos an executable by running chmod +x ~/aptos.

Verify that this installed version works by running ~/aptos help.

You should see instructions for how to use all CLI commands. These can be helpful in the future when you are trying to understand how to use specific commands.

(Optional) It can be helpful to add the Aptos CLI to a folder in your PATH, or to add it to your PATH directly.

  • The steps to add a folder to your PATH are shell dependent.
  • You can run echo $SHELL to print the default shell for your machine, then google specific steps to add a folder to your PATH for that shell.
ℹ️

When using the pre-compiled binaries method, you can update the Aptos CLI by deleting your existing installation, then following the installation steps again.

CLIWindows