minikit documentation

Everything a mini-app developer needs, served from the toolkit checkout you are running, so it always matches your minikit version.

The search box finds any word on any page. minikit docs <topic> opens a page directly; minikit docs --md <topic> prints it in the terminal.

Getting started

Install the toolkitgit clone or dart pub global activate, doctor, the simulator build
Create a mini appwhat minikit create gives you
Run, hot reload, debugthe simulator as a device, Chrome, breakpoints, DevTools
VS Code and Android StudioF5 and Run ▶ into the simulator

web/miniapp.jsonidentity, permissions, schema 2, migrating from Studio
minikit.yamlhow the toolkit runs, builds and packages a project
Writing the app with mini_app_sdkconnect, clients, errors as values, tests with LocalHost
Validate, build, package, hand overfrom build/web to the host team's catalog
The simulatorwhat it is, what it fakes, sim commands, the control API
Upgradingthe toolkit like flutter upgrade; projects with --project
Adding the framework to a host appminikit add vendors mini_app_host and updates it later
CI for a mini app--json, --no-input, exit codes, a GitHub Actions example
AI skills for coding agentsClaude Code, Cursor, Codex, Antigravity, Copilot, Gemini CLI; what ships and where it goes