use-algokit-cli

AlgoKit CLI commands for building, testing, and deploying Algorand applications. Use when building or compiling smart contracts, running test suites, deploying to localnet, managing local Algorand network, or understanding the development workflow. Strong triggers include "build the contract", "run the tests", "start localnet", "deploy to localnet", "algokit project run", "localnet status".

Stars 163

Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/use-algokit-cli

SKILL.md

AlgoKit Commands

Standard commands for Algorand development with AlgoKit CLI.

Overview / Core Workflow

Write contract code
Build: algokit project run build
Write tests using generated clients
Test: algokit project run test
Deploy: algokit project deploy localnet

How to proceed

Build contracts:
bash
```
algokit project run build
```
This compiles contracts via Puya, generates ARC56 specs, and creates typed clients.
Run tests:
bash
```
algokit project run test
```
Executes the test suite using Vitest.
Start localnet (if needed):
bash
```
algokit localnet start
```
Deploy to localnet:
bash
```
algokit project deploy localnet
```
Check build artifacts:
- artifacts/ — Compiled contracts, ARC56 specs
- Generated client files for TypeScript/Python

Important Rules / Guidelines

Always build before testing — Tests use generated clients
Only deploy when explicitly requested — Don't auto-deploy
Check localnet status before deployment operations
Reset localnet if you need a clean state

Common Variations / Edge Cases

Scenario	Command
Start local network	`algokit localnet start`
Stop local network	`algokit localnet stop`
Reset network state	`algokit localnet reset`
Check network status	`algokit localnet status`
Build fails	Check Puya compiler errors, fix contract code
Tests fail	Check test assertions, fix contract or test code

Search AI Tools