Skip to main content

Download Aptos CLI Binaries

The aptos tool is a command line interface (CLI) for developing on the Aptos blockchain, debugging Move contracts, and conducting node operations. This document describes how to install the aptos CLI tool using precompiled binaries that reduce variables in setting up your environment. Also see:

To download the Aptos source code, related tools, and IDE plugins for the Move programming language, follow the instructions below. Whenever possible, install the CLI by downloading the precompiled binary for your platform, as described below. If needed, you may build from source.

Use setup script

Aptos offers the dev_setup.sh script for establishing your development environment. This script currently supports macOS and Ubuntu Linux with other Linux distributions working but untested. The script does not support Windows. See the instructions below to manually install necessary dependencies.

macOS

macOS

tip

These instructions have been tested on macOS Monterey (12.6)

  1. Go to the Aptos CLI Release list.

  2. Click the Assets expandable menu for the latest release.

  3. You will see the zip files with the filename of the format: aptos-cli-<version>-<platform>. These are the platform-specific pre-compiled binaries of the CLI. Download the zip file for your platform, dismissing any warnings.

  4. Unzip the downloaded file. This will extract the aptos CLI binary file into your default downloads folder. For example, on macOS it is the ~/Downloads folder.

  5. Move this extracted aptos binary file into your preferred local folder. For example, place it in the ~/bin/aptos folder on macOS to make it accessible from the command line.

    :::tip Upgrading? Remember to look in the default download folder When you update the CLI binary with the latest version, note that the newer version binary will be downloaded to your default Downloads folder. Remember to move this newer version binary from the Downloads folder to the ~/bin/aptos folder to update and overwrite the older version. :::

  6. Make the ~/bin/aptos directory executable by running this command: chmod +x ~/bin/aptos

  7. Follow the simple steps recommended by the Apple support in Open a Mac app from an unidentified developer to remove the "unknown developer" blocker.

  8. Type ~/bin/aptos help to read help instructions.

  9. Add ~/bin to your path in your .bashrc or .zshrc file for future use.

Linux

Linux

tip

These instructions have been tested on Ubuntu 20.04.

  1. Go to the Aptos CLI release page.

  2. Click the Assets expandable menu for the latest release.

  3. You will see the zip files with the filename of the format: aptos-cli-<version>-<platform>. These are the platform-specific pre-compiled binaries of the CLI. Download the zip file for your platform, dismissing any warnings.

  4. Unzip the downloaded file. This will extract the aptos CLI binary file into your default downloads folder.

  5. Move this extracted aptos binary file into your preferred local folder.

    tip

    Upgrading? Remember to look in the default download folder When you update the CLI binary with the latest version, note that the newer version binary will be downloaded to your default Downloads folder. Remember to move this newer version binary from the Downloads folder to ~/bin/aptos folder (overwriting the older version).

  6. Make this ~/bin/aptos an executable by running this command:

    • chmod +x ~/bin/aptos.
  7. Type ~/bin/aptos help to read help instructions.

  8. Add ~/bin to your path in your .bashrc or .zshrc file for future use.

Windows 10, 11 and Windows Server 2022+

Windows 10, 11 and Windows Server 2022+

tip

These instructions have been tested on Windows 11 and Windows Server 2022. Windows support is new and some features may be not complete. Open Github issues for bugs.

  1. Go to the Aptos CLI release page.
  2. Click the Assets expandable menu for the latest release.
  3. You will see the zip files with the filename of the format: aptos-cli-<version>-<platform>. These are the platform-specific pre-compiled binaries of the CLI. Download the zip file for your platform, dismissing any warnings.
  4. Unzip the downloaded file. This will extract the aptos CLI binary file into your default downloads folder. For example, on Windows it is the \Users\user\Downloads folder.
  5. Move this extracted aptos binary file into your preferred local folder.
    Upgrading? Remember to look in the default download folder

    When you update the CLI binary with the latest version, note that the newer version binary will be downloaded to your default Downloads folder. Remember to move this newer version binary from the Downloads folder to your preferred location.

  6. Open a powershell terminal via the windows start menu
  7. In the powershell terminal, you can get help instructions by running the command with help. For example .\Downloads\aptos-cli-0.3.5-Windows-x86_64\aptos.exe help to read help instructions.