/algorand-project-setup

AlgoKit CLI Reference

Complete reference for AlgoKit CLI commands.

Contents

• Project Commands
• LocalNet Commands
• Generate Commands
• Init Commands
• Project Configuration
• Build Artifacts
• Common Workflows
• Utility Commands
• External Documentation

Project Commands

algokit project run build

Compile contracts and generate artifacts.

algokit project run build

What it does:

• Compiles contracts via Puya compiler
• Generates ARC-56 app specs (*.arc56.json)
• Creates typed client files
• Outputs to artifacts/ directory

algokit project run test

Run the test suite.

algokit project run test

What it does:

• Executes tests using Vitest
• Uses generated clients to interact with contracts
• Runs against localnet

algokit project link

Automatically invoke algokit generate client on contract projects in the workspace. Must be run from the root of a standalone frontend typed project.

# Link all contract projects with the frontend
algokit project link --all

# Link specific contract project(s)
algokit project link --project-name my-contracts

# In fullstack template workspaces, this is already configured — running build handles linking
algokit project run build

Key flags:

Use when: frontend needs typed clients from contracts in a fullstack workspace. Template projects handle this automatically via algokit project run build.

algokit project deploy

Deploy contracts to a network.

# Deploy to localnet
algokit project deploy localnet

Prerequisites:

• Localnet must be running
• Contracts must be built

LocalNet Commands

algokit localnet start

Start the local Algorand network.

algokit localnet start

What it does:

• Starts Docker containers for Algorand node
• Provides local development environment
• Includes KMD for test accounts

algokit localnet stop

Stop the local network.

algokit localnet stop

algokit localnet reset

Reset the network state.

algokit localnet reset

Use when:

• Need a clean slate
• State is corrupted
• Want to restart from genesis

algokit localnet status

Check network status.

algokit localnet status

Generate Commands

algokit generate client

Generate typed app clients from ARC-56 or ARC-32 application spec files.

# Generate TypeScript client
algokit generate client -o smart_contracts/artifacts/MyContract/MyContractClient.ts smart_contracts/artifacts/MyContract/MyContract.arc56.json

# Generate Python client
algokit generate client -o smart_contracts/artifacts/MyContract/my_contract_client.py --language python smart_contracts/artifacts/MyContract/MyContract.arc56.json

Key flags:

Note: In template projects, algokit project run build automatically compiles contracts and generates typed clients — you rarely need to run this command manually.

Init Commands

algokit init

Initialize a new project.

# TypeScript with Production preset
algokit init -n my-project -t typescript --answer preset_name production --defaults

# Python with Production preset
algokit init -n my-project -t python --answer preset_name production --defaults

Options:

Project Configuration

.algokit.toml

The .algokit.toml file configures project behavior:

[project]
type = "contract"
name = "my-project"
artifacts = "smart_contracts/artifacts"

[project.run]
build = "npm run build"
test = "npm run test"

[project.deploy]
command = "npm run deploy:ci"
environment_secrets = ["DEPLOYER_MNEMONIC"]

[project.deploy.localnet]
environment_secrets = []

[project.deploy.testnet]
environment_secrets = ["DEPLOYER_MNEMONIC"]

Environment Files

Environment variables can be set in .env files:

• .env — Default values for all environments
• .env.localnet — LocalNet-specific overrides
• .env.testnet — TestNet-specific values
• .env.mainnet — MainNet-specific values

# .env.testnet
ALGOD_SERVER=https://testnet-api.algonode.cloud
ALGOD_PORT=443
ALGOD_TOKEN=
DEPLOYER_MNEMONIC="word1 word2 ..."

The algokit project deploy command automatically loads the appropriate .env.{network} file.

Deploy Command Flags

# Deploy with specific deployer account
algokit project deploy testnet --deployer "DEPLOYER_NAME"

# Deploy with custom dispenser (for funding)
algokit project deploy testnet --dispenser "DISPENSER_NAME"

Build Artifacts

After algokit project run build:

smart_contracts/
└── artifacts/
    └── <ContractName>/
        ├── <ContractName>.arc56.json    # ARC-56 app spec
        ├── <ContractName>.approval.teal  # Approval program
        ├── <ContractName>.clear.teal     # Clear program
        └── <ContractName>Client.ts       # Typed client

Common Workflows

Development Cycle

# 1. Write/edit contract code
# 2. Build
algokit project run build

# 3. Write/edit tests
# 4. Run tests
algokit project run test

# 5. Repeat until passing

Deployment Workflow

# 1. Start localnet
algokit localnet start

# 2. Build contracts
algokit project run build

# 3. Deploy
algokit project deploy localnet

Clean Start

# Reset everything
algokit localnet reset
algokit project run build
algokit project run test

Utility Commands

algokit doctor

Check AlgoKit installation health and dependency versions.

algokit doctor

What it does:

• Verifies AlgoKit, Docker, Python, Node.js, and other dependency versions
• Reports missing or outdated tools
• Use as a first step when debugging CLI issues

algokit explore

Open the Lora blockchain explorer for the active network.

# Open explorer (defaults to LocalNet if running)
algokit explore

What it does:

• Opens Lora (https://lora.algokit.io) in the browser
• Connects to LocalNet, TestNet, or MainNet depending on configuration
• Useful for inspecting transactions, accounts, and application state

External Documentation

• AlgoKit CLI Documentation
• AlgoKit Project Commands
• AlgoKit LocalNet