Package: algokit
The Algorand AlgoKit CLI is the one-stop shop tool for developers building on theAlgorand 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.Install AlgoKit|Quick Start Tutorial|DocumentationWhat is AlgoKit?AlgoKit compromises of a number of components that make it the one-stop shop tool for developers building on theAlgorand network.AlgoKit can help youlearn,developandoperateAlgorand solutions. It consists ofa number of repositories, including this one.LearnThere are many learning resources on theAlgorand Developer Portaland theAlgoKit landing pagehas a range of links to more learning materials. In particular, check out thequick start tutorialand theAlgoKit detailed docs page.If you need help you can access both theAlgorand Discord(pro-tip: check out the algokit channel!) and theAlgorand Forum.We have also developed anAlgoKit video series.DevelopAlgoKit helps you develop Algorand solutions:Interaction: AlgoKit exposes a number of interaction methods, namely:AlgoKit CLI: A Command Line Interface (CLI) so you can quickly access AlgoKit capabilitiesVS Code: All AlgoKit project templates include VS Code configurations so you have a smooth out-of-the-box development experience using VS CodeDappflow: AlgoKit has integrations with Dappflow; a web-based user interface that let's you visualise an Algorand network and deploy and call smart contracts via a graphical user interfaceGetting 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 experienceDevelopment: 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 easilyalgosdk(Python|TypeScript) - The core Algorand SDK providing Algorand protocol API calls, which AlgoKit Utils wraps, but still exposes for advanced scenariosBeaker: A productive Python framework for building Smart Contracts on Algorand.PyTEAL: The Python language bindings for Algorand Smart Contracts, which Beaker wrapsTEAL: Transaction Execution Approval Language (TEAL) is the assembly-like language interpreted by the Algorand Virtual Machine (AVM) running within an Algorand node, which Beaker exportsAlgoKit LocalNet: A local isolated Algorand network so you can simulate real transactions and workloads on your computerOperateAlgoKit can help you deploy and operate Algorand solutions.AlgoKit comes with out-of-the-boxContinuous Integration / Continuous Deployment (CI/CD) templatesthat help you rapidly set up best-practice software delivery processes that ensure you build quality in and have a solution that can evolveWhat can AlgoKit help me do?The set of capabilities supported by AlgoKit will evolve over time, but currently includes:Quickly run, explore and interact with an isolated local Algorand network (LocalNet)Building, testing, deploying and callingAlgorand PyTEAL/Beakersmart contractsFor a user guide and guidance on how to use AlgoKit, please refer to thedocs.Future capabilities are likely to include:Quickly deploystandardised, audited smart contractsBuilding and deploying Algorand dAppsIs this for me?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 thecontributing pageto learn about making improvements to the CLI tool itself, including developer setup instructions.InstallPrerequisitesThe key required dependency is Python 3.10+, but some of the installation options below will install that for you.AlgoKit also has some runtime dependencies that also need to be available for particular commands.NoteYou can still install and use AlgoKit without these dependencies and AlgoKit will tell you if you are missing one for a given command.Git - Git is used when creating and updating projects from templatesDocker - Docker Compose (and by association, Docker) is used to run the AlgoKit LocalNet environment, we require Docker Compose 2.5.0+Cross-platform installationAlgoKit can be installed using OS specific package managers, or using the python toolpipxsee below for specific installation instructions.WindowsMacLinuxpipxInstall AlgoKit on WindowsNoteThis method will install the most recent python3 versionvia winget. If you already have python 3.10+ installed, you mayprefer to use pipx directly insteadso you can control the python version used.Ensure prerequisites are installedGit(orwinget install git.git)Docker(orwinget install docker.dockerdesktop)NoteSeeour LocalNet documentationfor more tips on installing Docker on WindowsInstall using WinGetInstall python:winget install python.python.3.11Restart the terminal to ensure Python and pip are available on the pathNoteWindows has a feature calledApp Execution Aliasesthat provides redirects for the Python command that guide users to the
Windows Store. Unfortunately these aliases can prevent normal execution of Python if Python is installed via other means, to disable them
search forManage app execution aliasesfrom the start menu, and then turn off entries listed asApp Installer python.exeorApp Installer python3.exe.Install pipx:pip install --user pipx
python -m pipx ensurepathRestart the terminal to ensure pipx is available on the pathInstall AlgoKit via pipx:pipx install algokitRestart the terminal to ensure AlgoKit is available on the pathVerify installationMaintenanceSome useful commands for updating or removing AlgoKit in the future.To update AlgoKit:pipx upgrade algokitTo remove AlgoKit:pipx uninstall algokitInstall AlgoKit on MacNoteThis method will install Python 3.10 as a dependency via Homebrew. If you already have python installed, you may prefer to usepipx install algokitas explainedhere.Ensure prerequisites are installedHomebrewGit(should already be available ifbrewis installed)Docker, (orbrew install --cask docker)NoteDocker requires MacOS 11+Install using Homebrewbrew install algorandfoundation/tap/algokitRestart the terminal to ensure AlgoKit is available on the pathVerify installationMaintenanceSome useful commands for updating or removing AlgoKit in the future.To update AlgoKit:brew upgrade algokitTo remove AlgoKit:brew uninstall algokitInstall AlgoKit on LinuxEnsure prerequisites are installedPython 3.10+NoteThere is probably a better way to install Python than to download it directly, e.g. your local Linux package managerpipxGitDockerContinue with step 2 in the following section to install viapipxInstall AlgoKit with pipx on any OSEnsure desired prerequisites are installedPython 3.10+pipxGitDockerInstall using pipxpipx install algokitRestart the terminal to ensure AlgoKit is available on the pathVerify installationMaintenanceSome useful commands for updating or removing AlgoKit in the future.To update AlgoKit:pipx upgrade algokitTo remove AlgoKit:pipx uninstall algokitVerify installationVerify AlgoKit is installed correctly by runningalgokit --versionand you should see output similar to:algokit, version 1.0.1NoteIf you get 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)Then ensure thatalgokitis available on the PATH by runningpipx ensurepathand restarting the terminal.It is also recommended that you runalgokit doctorto verify there are no issues in your local environment and to diagnose any problems if you do have difficulties running AlgoKit. The output of this command will look similar to:timestamp: 2023-03-27T01:23:45+00:00
AlgoKit: 1.0.1
AlgoKit Python: 3.11.1 (main, Dec 23 2022, 09:28:24) [Clang 14.0.0 (clang-1400.0.29.202)] (location: /Users/algokit/.local/pipx/venvs/algokit)
OS: macOS-13.1-arm64-arm-64bit
docker: 20.10.21
docker compose: 2.13.0
git: 2.37.1
python: 3.10.9 (location:  /opt/homebrew/bin/python)
python3: 3.10.9 (location:  /opt/homebrew/bin/python3)
pipx: 1.1.0
poetry: 1.3.2
node: 18.12.1
npm: 8.19.2
brew: 3.6.18

If you are experiencing a problem with AlgoKit, feel free to submit an issue via:
https://github.com/algorandfoundation/algokit-cli/issues/new
Please include this output, if you want to populate this message in your clipboard, run `algokit doctor -c`Per the above output, the doctor command output is a helpful tool if you need to ask for support orraise an issue.