use-algokit-cli

AlgoKit Commands

Standard commands for Algorand development with AlgoKit CLI.

Overview / Core Workflow

1. Write contract code
2. Build: algokit project run build
3. Write tests using generated clients
4. Test: algokit project run test
5. Deploy: algokit project deploy localnet

How to proceed

1. Build contracts:

   algokit project run build
   

   This compiles contracts via Puya, generates ARC56 specs, and creates typed clients.

2. Run tests:

   algokit project run test
   

   Executes the test suite using Vitest.

3. Start localnet (if needed):

   algokit localnet start
   

4. Deploy to localnet:

   algokit project deploy localnet
   

5. 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

References / Further Reading

• Full CLI Reference
• AlgoKit CLI Documentation
• AlgoKit Project Commands