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.

referencesproject-templates.md

≈1.4k tokens on demand. Your agent reads this file only when SKILL.md points to it.

AlgoKit Init CLI Reference

Templates

Template Language Use Case
typescript TypeScript Smart contracts (Algorand TypeScript/PuyaTs)
python Python Smart contracts (Algorand Python/PuyaPy)
tealscript TypeScript Smart contracts (TealScript - alternative)
react TypeScript Frontend dApp with wallet integration
fullstack Both Smart contracts + React frontend combined
base N/A Minimal workspace template

Default template: fullstack (smart contracts + React frontend with TypeScript)

Presets

TypeScript

Preset Description
Starter Simple starting point
Production Tests, CI/CD, linting, audit
Custom Choose individual options (testing, CI, etc.)

Python

Preset Description
Starter Simple starting point
Production Tests, CI/CD, linting, type checking
Custom Choose individual options (testing, CI, etc.)

Command Patterns

# Fullstack — TypeScript contracts + React frontend (default)
algokit init -n <name> -t fullstack --answer preset_name production --answer contract_template typescript --defaults

# Fullstack — Python contracts + React frontend
algokit init -n <name> -t fullstack --answer preset_name production --answer contract_template python --defaults

# Smart contracts only — TypeScript (Production preset)
algokit init -n <name> -t typescript --answer preset_name production --answer author_name "<author>" --defaults

# Smart contracts only — Python (Production preset)
algokit init -n <name> -t python --answer preset_name production --answer author_name "<author>" --defaults

# Frontend only — React dApp
algokit init -n <name> -t react --defaults

# Skip git and bootstrap
algokit init -n <name> -t fullstack --answer contract_template typescript --no-git --no-bootstrap --defaults

Fullstack Workspace Structure

The fullstack template creates a workspace with sub-projects:

<project-name>/
├── projects/
│   ├── <project-name>-contracts/   # Smart contract sub-project
│   │   ├── smart_contracts/        # Contract source code
│   │   └── tests/                  # Contract tests
│   └── <project-name>-frontend/    # React frontend sub-project
│       ├── src/                    # React app source
│       └── public/
├── .algokit.toml                   # Workspace config
└── README.md

Both sub-projects share a single workspace and can be built/tested together via algokit project run commands from the root.

Fullstack Template Answer Keys

These are the exact --answer keys accepted by the fullstack template (from its copier.yaml):

Key Type Values Default
contract_template str typescript, python, tealscript python
preset_name str starter, production, custom starter
contract_name str snake_case (python) or PascalCase (ts) hello_world
author_name str Any Your-Name
author_email str Any your@email.tld
deployment_language str python, typescript (python contracts only) python

IMPORTANT: The contract language key is contract_template, NOT contract or frontend. The default is python, so you must pass --answer contract_template typescript to get TypeScript contracts.

Options

Flag Description
-n, --name <name> Project directory name (required)
-t, --template <name> Template name (see Templates table above)
--answer "<key>" "<value>" Answer template prompts
--defaults Accept all defaults
--no-git Skip git initialization
--no-bootstrap Skip dependency installation
--workspace Create within workspace structure (default)
--no-workspace Create standalone project
--ide / --no-ide Open IDE after creation (default: auto-detect)

Initialize from Examples

AlgoKit can also initialize projects from pre-built examples:

# Interactive example selector
algokit init example

# List available examples
algokit init example --list

# Initialize specific example
algokit init example <example_id>

Full Reference

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