Launch Fleet from CLI

Sometimes a particular workflow would require you to launch JetBrains Fleet from the command line. To support these, JetBrains 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 JetBrains Fleet.

Launch Fleet

The following commands launch a local instance of JetBrains Fleet.
- fleet – launches JetBrains 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, JetBrains Fleet creates a new one.
- fleet --goto=<file-name>:line[:column] – opens the specified file on a certain line and column.
  Examples:
  - fleet my/dir --goto=my/file:10: opens ./my/dir and ./my/file on line 10.
  - fleet -- --goto=my/file:10: opens .my/file on line 10.
  - fleet -- --goto=my/file:10:5: opens .my/file on line 10 and column 5.
  - fleet -- --goto=my/file:10 --goto=my/file2:5:2: opens .my/file on line 10 and ./my/file2 on line 5 and column 2.
  - fleet my/file/without/col/line:5 --goto=my/file:10: opens ./my/file/without/col/line:5 on line 5 and column 1 and .my/file on line 10.

Options

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

-d

Enables logging of debug messages in the launcher.

For logging of debug messages in JetBrains 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.

Last modified: 15 April 2024