🚀 Join the waitlist now! waitlist.floot.dev
LogoFlootdocs

Install

Install the command-line tool that creates and manages Floot projects, with one command.

The Floot CLI creates new projects and manages the tools a Floot project needs. Install it with one command, then sign in with floot login.

Install script

The install script downloads a standalone floot binary for your machine, checks its checksum and puts it on your path. It needs nothing else installed.

On macOS and Linux:

Terminal
curl -fsSL https://floot.dev/install.sh | sh

On Windows, in PowerShell:

PowerShell
irm https://floot.dev/install.ps1 | iex

The script installs to ~/.floot/bin on macOS and Linux, and to %LOCALAPPDATA%\floot\bin on Windows. If that folder is not on your PATH yet, the script says so and prints the line to add. On Windows it adds the folder to your user PATH for you; open a new terminal for it to take effect.

Homebrew

On macOS and Linux, install from the Floot tap:

Terminal
brew install floot-dev/floot/floot

Scoop

On Windows, add the Floot bucket, then install:

PowerShell
scoop bucket add floot https://github.com/floot-dev/scoop-floot
scoop install floot

pub.dev

If you already have the Dart SDK, floot_cli is published on pub.dev:

Terminal
dart pub global activate floot_cli

Which one should I pick?

Any of them gives you the same CLI. The difference is who keeps it current: the script and pub.dev installs replace themselves when you run floot update, while Homebrew and Scoop installs are upgraded by their own manager. floot update is the one command for all four, and the update page says what it does for each.

Verify

Terminal
floot --help

Possible Installation Issue

If floot is not found, the folder it was installed into is not on your system PATH. For a pub.dev install that is the Dart Pub cache directory; for the script it is the folder named above. Add it and try again.

A working install prints something like this:

CLI of Floot starter kit.

Usage: floot <command> [arguments]

Global options:
-h, --help            Print this usage information.
-v, --version         Print the current version.
    --[no-]verbose    Noisy logging, including all shell commands executed.

Available commands: ...

Next step

Sign in once, and every command that needs a license takes it from there. The licensing page covers how sign in, seats and devices fit together.

Terminal
floot login

Commands

On this page