name: create-project
description: Bootstraps production-ready AlgoKit projects for Algorand dApps and smart contracts. Use when initializing new Algorand smart contract projects, setting up development environments from scratch, or scaffolding dApps with pre-configured tooling. Strong triggers include "create a new project", "initialize a new Algorand app", "start a new smart contract", "set up AlgoKit", "scaffold a dApp", "algokit init".

AlgoKit Project Initialization

Create new Algorand projects using AlgoKit's official templates.

Overview / Core Workflow

1. Confirm project details with user (name, template, customizations)
2. Run algokit init with appropriate flags
3. Handle any initialization errors
4. Provide next steps for building/testing

How to proceed

1. Confirm project details with user:
2. Project name (directory name)
3. Template choice (TypeScript or Python)
4. Any customizations (--no-git, --no-bootstrap, author name)

5. For TypeScript: confirm Production preset for production projects

6. Run initialization command:

TypeScript (Production Preset):

bash algokit init -n <project-name> -t typescript --answer preset "Production" --answer author_name "<name>" --defaults

TypeScript (Starter Preset):

bash algokit init -n <project-name> -t typescript --answer author_name "<name>" --defaults

Python (Production Preset):

bash algokit init -n <project-name> -t python --answer preset "Production" --answer author_name "<name>" --defaults

Python (Starter Preset):

bash algokit init -n <project-name> -t python --answer author_name "<name>" --defaults

With custom options (no git, no bootstrap):

bash algokit init -n <project-name> -t typescript --no-git --no-bootstrap --defaults

1. Handle errors:
2. Check if project directory already exists
3. Verify AlgoKit is installed: algokit --version
4. Ensure target directory is writable

5. Valid templates: typescript, python, tealscript, react, fullstack, base

6. Provide next steps:

7. cd <project-name>
8. algokit project run build — Compile contracts
9. algokit project run test — Run test suite
10. algokit localnet start — Start local network (if deploying)
11. algokit project run deploy — Deploy contracts to local network

Important Rules / Guidelines

• Always confirm with user before executing — Never run algokit init without explicit confirmation
• Default to TypeScript — Recommended for production applications
• Use Production preset — For any project because it includes testing framework and deployment scripts
• Include author name — Pass --answer author_name "<name>" for attribution
• Use --defaults — Accepts all other default values for non-interactive mode

Common Variations / Edge Cases

References / Further Reading

• CLI Reference
• AlgoKit CLI Init Documentation
• AlgoKit CLI Init Reference