FleetbaseFleetbase

Commands

Reference table of every Fleetbase CLI command with a one-line description and a link to its page.

Commands

Quick reference for every command the flb CLI exposes. Click any command for the full options, examples, and behavior.

Install Fleetbase

CommandDescription
flb install-fleetbaseInteractive Docker-based wizard that installs a self-hosted Fleetbase instance

Account

CommandDescription
flb registerCreate a new Fleetbase Extension Registry developer account
flb verifyVerify a registry account email and receive your auth token
flb resend-verificationRequest a fresh verification code
flb loginLog in to the registry with username + password (writes to ~/.npmrc)
flb set-authWrite a registry auth token into a Fleetbase instance's console/.npmrc and api/auth.json
flb generate-tokenGenerate (or regenerate) a long-lived registry auth token

Manage Extensions

CommandDescription
flb searchBrowse and filter the Extension Registry from the command line
flb installInstall an extension into a running Fleetbase instance
flb uninstallRemove an installed extension from a Fleetbase instance

Publish Extensions

CommandDescription
flb scaffoldGenerate a new extension from the starter template
flb version-bumpIncrement the version across extension.json, package.json, and composer.json
flb bundlePack an extension into a versioned .tar.gz
flb bundle-uploadUpload an existing bundle to the registry
flb publishPublish an extension to the registry via npm publish
flb unpublishRemove a published extension from the registry

Built-in

CommandDescription
flb --version (or -v)Print the CLI version
flb --helpShow top-level help and command list
flb <command> --helpShow help for a specific command

Global Options

These options work with every command:

OptionDefaultDescription
-v, --versionPrint the CLI version
-r, --registry [url]https://registry.fleetbase.ioOverride the registry URL
--helpShow help for the current command
Commands | Fleetbase