Index of every page on this site: llms.txt
All skills
algorandfoundation avatar

/algorand-project-setup

@12acef7
Run it yourself

Scaffolds Algorand projects using AlgoKit CLI, manages LocalNet, and retrieves code examples from official GitHub repositories. Use when initializing projects with algokit init, running build/test/deploy commands, starting or resetting LocalNet, or searching for Algorand contract examples and patterns.

  • 4 files
  • 20 KB
  • Updated 8 months ago
  • GitHub
Use this Skill: https://skilld.dev/gh/algorandfoundation/algorand-agent-skills/algorand-project-setup

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈82 tokens for metadata: the name and description. ≈587 when used: this file. ≈4.4k more on demand in 3 files.

Description uses 4.1% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈328 characters, or 4.1%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

AlgoKit Project Setup & Examples

Quick Start

# Install AlgoKit
pipx install algokit

# Create a fullstack project — smart contracts + React frontend (default)
algokit init -n my-project -t fullstack --answer preset_name production --answer contract_template typescript --defaults

# Development cycle
cd my-project
algokit project run build    # Compile contracts
algokit project run test     # Run tests
algokit localnet start       # Start local network
algokit project deploy localnet  # Deploy

Reference Guide

Creating Projects

Initialize new Algorand projects using AlgoKit templates and presets.

CLI Commands

Build, test, deploy, and manage LocalNet with AlgoKit CLI.

Searching Examples

Find working contract examples from Algorand Foundation repositories using GitHub tools.

Important Rules

  • Always confirm with user before running algokit init
  • Default to fullstack template (-t fullstack) with TypeScript contracts and production preset — MUST pass --answer contract_template typescript since the default is Python
  • Always build before testing — tests use generated clients
  • Search algorandfoundation repos first — official, vetted examples

Canonical Example Repos

Repository Best For
algorandfoundation/devportal-code-examples Beginner-friendly contract examples (TypeScript + Python)
algorandfoundation/puya-ts Advanced TypeScript contract examples
algorandfoundation/puya Advanced Python contract examples
algorandfoundation/algokit-fullstack-template Fullstack project template (contracts + React)

Always fetch corresponding test files alongside contract examples.

Cross-References

  • algorand-core — AVM mental model, transaction types, protocol concepts
  • algorand-typescript / algorand-python — Contract development syntax and patterns
  • algorand-frontend — React frontend integration and wallet connection

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at 12acef7. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last month.

Steadyupdated 8 months ago

README badge

README badge for algorandfoundation/algorand-agent-skills/algorand-project-setup