use-algokit-cli

Automate Algorand project build, test, and localnet deployment workflows.

2|Updated Jul 29, 2025
One-click install
npx skills add https://github.com/algorandfoundation/xgov-committees --skill use-algokit-cli-algorandfoundation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: use-algokit-cli
Source: https://github.com/algorandfoundation/xgov-committees/tree/main/.claude/skills/use-algokit-cli
Command: npx skills add https://github.com/algorandfoundation/xgov-committees --skill use-algokit-cli-algorandfoundation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

AlgoKit CLI helps developers manage the full lifecycle of Algorand smart-contract projects, reducing context switching and setup time.

Core Features & Use Cases

  • Build contracts: compile and generate ARC-56 specs, and create typed clients.
  • Test projects: run tests against a localnet using generated clients.
  • Deploy to localnet: initialize and run deployments for development and testing.
  • Use Case: Imagine a developer iterating an Algorand smart contract from write, compile, test to deploy on a local network for rapid feedback.

Quick Start

Initialize your Algokit project, build contracts with algokit project run build, run tests with algokit project run test, and deploy to localnet with algokit project deploy localnet.

Frequently Asked Questions about use-algokit-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build and test Algorand smart contracts against a local network?

You can build and test Algorand smart contracts by running 'algokit project run build' to compile and generate ARC-56 typed clients, then 'algokit project run test' to execute tests against the localnet for rapid feedback.

What is the best way to automate an Algorand smart contract development lifecycle?

The best way to automate an Algorand development lifecycle is using the AlgoKit CLI to manage project setup, compilation, testing, and localnet deployment. This enforces a repeatable end-to-end process, reducing context switching and manual setup time.

How do I deploy an Algorand contract to a localnet for development?

To deploy an Algorand contract to a localnet, initialize your AlgoKit project and run 'algokit project deploy localnet'. This initializes and executes the deployment for local development and testing environments.

Can I generate typed clients when compiling Algorand smart contracts?

Yes, you can generate typed clients when compiling Algorand smart contracts. Running the AlgoKit CLI build command compiles contracts, generates ARC-56 specs, and creates typed clients for use in your tests and deployments.

Do I need a specific environment setup to use AlgoKit CLI for Algorand development?

AlgoKit CLI requires an environment supporting its standard command-line interface operations. It manages the full lifecycle of Algorand smart-contract projects locally without requiring external dependencies, streamlining the setup process for developers.