Launch Fleet from CLI

Sometimes a particular workflow would require you to launch Fleet from the command line. To support these, Fleet has several commands, which you can use in a shell script or a terminal.

Generate scripts

In the Toolbox app, click Toolbox App menu, then select Settings.
Under Tools, enable Generate shell scripts.
In Shell scripts location, specify a folder that is accessible through the PATH variable.

Configure command name

In the Toolbox app, click Tool actions near Fleet, then select Settings.
Under Shell script name, specify the name for the command that launches Fleet.

Launch Fleet locally

The following commands launch a local instance of Fleet.
- fleet – launches Fleet in its last saved state.
- fleet <dir-name> – opens the specified directory in Fleet as a new workspace.
- fleet <file-name> – attaches the specified file to the open workspace. If no workspace is available, Fleet creates a new one.

Start a workspace for remote development

Run the following command:
fleet -s <dir-name>
Fleet launches a workspace and a backend for the specified directory. You can then use the URL from the command output to connect to this workspace.

Options and flags

The table below provides the summary for the options and flags that you can use with the fleet command.

Options
-s	Launches a workspace and a backend for the specified directory. Use this for setting up a remote development environment.

Flags
-d	Enables logging of debug messages in the launcher. For logging of debug messages in Fleet itself, use the `FLEET_DEBUG_MODE` environment variable or `fleet.debug.mode` VM option.
-h	Provides the reference for the available options and flags.
-t	Without `-t`, the launcher will look for a running Fleet instance and send an open command to it via a socket. If there is no running instance, it will attempt to directly launch one by explicitly executing the binary. With `-t`, it is the Toolbox that actually launches Fleet, and the launcher only delegates there. This may be required if you want to connect to a workspace that is running a different Fleet workspace version than the launcher would locally launch. Then Toolbox will download the correct version and launch that instead.
-V	Prints out the version of Fleet.

Last modified: 07 June 2022