| title | Requirements |
|---|---|
| description | What you need installed before using the Fleetbase CLI — Node, plus Docker and Git for installing Fleetbase itself. |
The CLI itself runs on Node. Some commands additionally need Docker, Git, pnpm, or PHP/Composer on your machine.
| Tool | Notes |
|---|---|
| Node.js ≥ 18 | The CLI is published as @fleetbase/cli on npm |
| npm (or pnpm / yarn) | Used to install the CLI globally |
| Tool | Notes |
|---|---|
| Docker | Required — the wizard runs docker compose up -d |
| Docker Compose v2 | The wizard checks for the docker compose plugin (not the legacy docker-compose binary) |
| Git | Used to clone github.com/fleetbase/fleetbase.git if the target directory isn't already a checkout |
The installer also pre-flight checks these ports for availability:
- 8000 — API
- 4200 — Console
- 3306 — MySQL
- 38000 — SocketCluster
Conflicts on any of these print a warning but don't abort — the installer continues so you can decide whether to free the port.
The CLI installs extensions by running pnpm install (in the console/ directory) and composer require (in the api/ directory) of your Fleetbase checkout. You'll need:
| Tool | Notes |
|---|---|
| pnpm | Required — Fleetbase uses pnpm in the console workspace |
| PHP / Composer | Required — used to install the API-side composer package |
flb install and flb uninstall need the path to your Fleetbase instance — the directory that contains the console/ and api/ folders. Pass it via --path /path/to/fleetbase, or run the command from inside that directory.
| Tool | Notes |
|---|---|
| npm | Used under the hood for the publish flow (npm publish) |
| A registry account | Register and verify to get an auth token |
The CLI runs on macOS, Linux, and Windows (via WSL2 for Docker-based commands). The installer wizard is tested on macOS and Linux; on Windows, run it inside WSL2.