AlgoKit is a command-line interface (CLI) tool designed to streamline development on the Algorand blockchain network. It provides developers with a comprehensive suite of utilities to build, test, and deploy applications efficiently.
Key Features:
Seamless integration with Algorand’s blockchain for smart contract deployment and transaction processing.
Local development environment that mirrors production settings for accurate testing.
Pre-built transaction templates to simplify complex operations.
Package management to easily install, update, and manage dependencies.
Audience & Benefit:
Ideal for developers building decentralized applications (dApps) on Algorand. It accelerates the development process, reduces errors, and ensures compatibility with the Algorand network.
AlgoKit can be installed via winget, making it easy to integrate into your existing workflow.
README
The Algorand AlgoKit CLI is the one-stop shop tool for developers building on the Algorand network.
AlgoKit gets developers of all levels up and running with a familiar, fun and productive development environment in minutes. The goal of AlgoKit is to help developers build and launch secure, automated production-ready applications rapidly.
Interaction: AlgoKit exposes a number of interaction methods, namely:
AlgoKit CLI: A Command Line Interface (CLI) so you can quickly access AlgoKit capabilities
VS Code: All AlgoKit project templates include VS Code configurations so you have a smooth out-of-the-box development experience using VS Code
lora: AlgoKit has integrations with lora; a web-based user interface that let's you visualise and interact with an Algorand network
Getting Started: AlgoKit helps you get started quickly when building new solutions:
AlgoKit Templates: Template libraries to get you started faster and quickly set up a productive dev experience
Development: AlgoKit provides SDKs, tools and libraries that help you quickly and effectively build high quality Algorand solutions:
AlgoKit Utils (Python | TypeScript): A set of utility libraries so you can develop, test, build and deploy Algorand solutions quickly and easily
Algorand SDKs - The core Algorand SDK providing Algorand protocol API calls, which AlgoKit Utils wraps, but still exposes for advanced scenarios
Algorand Python: A semantically and syntactically compatible, typed Python language that works with standard Python tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM).
Algorand TypeScript (Beta): A semantically and syntactically compatible, typed TypeScript language that works with standard TypeScript tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM). This language is currently in beta.
TEALScript: A subset of TypeScript that can be used to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM).
AlgoKit LocalNet: A local isolated Algorand network so you can simulate real transactions and workloads on your computer
Operate
AlgoKit can help you deploy and operate Algorand solutions.
The target audience for this tool is software developers building applications on the Algorand network. A working knowledge of using a command line interfaces and experience using the supported programming languages is assumed.
How can I contribute?
This is an open source project managed by the Algorand Foundation. See the contributing page to learn about making improvements to the CLI tool itself, including developer setup instructions.
Install
> Note Refer to Troubleshooting for more details on mitigation of known edge cases when installing AlgoKit.
Prerequisites
No prerequisites are required to install AlgoKit itself. The install script handles everything.
Depending on the features you choose to leverage from the AlgoKit CLI, additional dependencies may be required.
The AlgoKit CLI will tell you if you are missing one for a given command. These optional dependencies are:
Git: Essential for creating and updating projects from templates. Installation guide available at Git Installation.
Docker: Necessary for running the AlgoKit LocalNet environment. Docker Compose version 2.5.0 or higher is required. See Docker Installation.
Node.js: For those working on frontend templates or building contracts using Algorand TypeScript or TEALScript. Minimum required versions are Node.js v22 and npm v10. See Node.js Installation.
Quick Install (Recommended)
AlgoKit is installed via uv, which handles Python and dependency management automatically.
> Note
> The following installation methods are being phased out in favor of the uv-based installation above.
> They will continue to work for existing installations but are no longer the recommended approach.
Click to expand legacy installation methods
Install AlgoKit on Windows (winget)
Ensure prerequisites are installed
WinGet (should be installed by default on recent Windows 10 or later)
Verify AlgoKit is installed correctly by running algokit --version and you should see output similar to:
algokit, version 2.10.2
> Note
> If you receive one of the following errors:
>
> - command not found: algokit (bash/zsh)
> - The term 'algokit' is not recognized as the name of a cmdlet, function, script file, or operable program. (PowerShell)
>
> Ensure that ~/.local/bin is on your PATH and restart the terminal.
It is also recommended that you run algokit doctor to verify there are no issues in your local environment and to diagnose any problems if you do have difficulties running AlgoKit.
Troubleshooting
This section addresses specific edge cases and issues that some users might encounter when interacting with the CLI. The following table provides solutions to known edge cases:
Issue Description
OS(s) with observed behaviour
Steps to mitigate
References
Python was built without --with-ssl flag, causing pip to fail
Debian 12
Run sudo apt-get install -y libssl-dev and reinstall python with --with-ssl flag enabled
