minikit docs v0.1.0-alpha.3

Install the toolkit

You need Flutter 3.44 or newer (its bundled Dart is enough), git, and a macOS machine to use the simulator window. Windows and Linux run mini apps through Chrome until the simulator's embedded WebView lands there.

git clone -b main https://github.com/mohamedyousef/mini_kit.git ~/minikit
export PATH="$HOME/minikit/bin:$PATH"     # add this line to your shell profile
minikit doctor

bin/minikit is a small bootstrap: it finds the Dart SDK next to your flutter, compiles the CLI once per checkout revision into bin/cache/ (a few seconds) and runs it. Nothing else is installed on your machine. The repository is private: your GitHub account must have access.

With dart pub global activate

dart pub global activate --source git https://github.com/mohamedyousef/mini_kit.git \
    --git-path cli/minikit --git-ref main

pub clones the repository into its cache and puts minikit on ~/.pub-cache/bin. The CLI finds the toolkit content (templates, packages, docs, skills) two levels above its own package, so everything works the same way. minikit upgrade tells you the activate command to run again.

The simulator build

The simulator is a native app (Flutter + Rust) that is not built on your machine. minikit doctor looks for it in the toolkit cache (bin/cache/simulator/<version>/), in /Applications, and in a simulator/build you made yourself. minikit sim install downloads the build for your Mac from the toolkit's GitHub Release (through gh, a MINIKIT_GITHUB_TOKEN, or the download URL) and verifies its sha256; minikit sim install --from <zip> takes a zip you already have. Contributors build it with flutter build macos inside simulator/.

Check

minikit doctor reports the toolchain (Flutter within the tested range), the toolkit checkout, the simulator build, Chrome, IDEs, and — inside a project — the project's files. Every finding comes with a fix.

Served offline by minikit docs from your toolkit checkout. Source: docs/getting-started/install.md.