AlgoKit Installation
Get AlgoKit installed on your system and start building on Algorand. Follow the installation guide for your operating system to set up the complete development environment.
Prerequisites
Before installing AlgoKit, ensure you have the following components installed on your system:
Note: Some installation methods will automatically install Python and other dependencies. Check the specific instructions for your operating system below.
Installation Methods
Windows Installation
Note: This method installs the most recent Python 3 version via winget. If you already have Python 3.12+ installed, you may prefer to use the OS Agnostic method.
Step 1: Install Prerequisites
Install Git and Docker using Windows Package Manager:
Install Git:
winget install git.gitInstall Docker Desktop:
winget install docker.dockerdesktopInfo: See our LocalNet documentation for additional tips on installing Docker on Windows.
Step 2: Install Python
winget install python.python.3.12Restart the terminal after installation to ensure Python and pip are available on the path.
Windows App Execution Aliases: Windows has a feature that provides redirects for the Python command. If Python is installed via other means, disable these aliases by searching for "Manage app execution aliases" and turning off entries for python.exe and python3.exe.
Step 3: Install pipx and AlgoKit
Install pipx:
pip install --user pipxEnsure pipx is on the path:
python -m pipx ensurepathRestart the terminal, then install AlgoKit:
pipx install algokitIf updating from a previous version:
pipx upgrade algokitRestart the terminal to ensure AlgoKit is available on the path.
Verify Installation
To verify that AlgoKit has been installed correctly, run the following command:
algokit --versionOutput similar to the following should be displayed:
algokit, version 2.0.0Installation Complete!
AlgoKit is now installed and ready to use. You can start building on Algorand!
Troubleshooting
Common issues and their solutions:
Command not found: algokit
This usually means pipx is not in your PATH. Try:
pipx ensurepathThen restart your terminal and try again.
Python version too old
AlgoKit requires Python 3.12 or higher. Check your version:
python --versionIf your version is older, please upgrade Python from python.org
Docker issues
If LocalNet fails to start, ensure Docker is running:
docker --versionMake sure Docker Desktop is running and you have sufficient permissions.
Permission denied errors
If you encounter permission errors during installation:
pip install --user pipxUse the --user flag to install packages in your user directory instead of system-wide.