JetBrains Fleet 1.42 Help

Launch JetBrains 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

  1. In the Toolbox app, click Toolbox App menu, then select Settings.

    Toolbox settings menu

  2. Under Tools, enable Generate shell scripts.

  3. In Shell scripts location, specify a folder that is accessible through the PATH variable.

Configure a command name

  1. In the Toolbox app, click Tool actions near JetBrains Fleet, then select Settings.

    Tool actions menu in Toolbox

  2. Under Shell script name, specify the name for the command that launches JetBrains Fleet.

Launch JetBrains 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 JetBrains 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://fleet.ssh/<hostname>?<query_params>: connect to SSH using a URI handler. For more information, refer to Connecting to SSH with JetBrains Fleet URI handler.

      • 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.

Connecting to SSH with JetBrains Fleet URI handler

Starting with version 1.36, JetBrains Fleet will support direct connections to SSH using a URI handler. This allows you to connect to remote hosts from the command line using a streamlined URI format.

The URI format for connecting to SSH with JetBrains Fleet is:

fleet://fleet.ssh/<hostname>?<query_params>

On macOS, the format is the following:

open "fleet://fleet.ssh/<hostname>?<query_params>"
fleet_connecting_to_ssh_with_instance_uri_handler

Parameters

You can use the following parameters within the URI to customize your connection:

  • hostname (required): The address of the remote host you wish to connect to.

  • username (optional): The username for the SSH connection. You can also specify this as part of the hostname using the SSH URI syntax: <username>@<hostname>.

  • port (optional): The port number for the SSH connection. You can also specify this alongside the hostname using the SSH URI syntax: <hostname>:<port>.

  • pwd (optional): The working directory to open on the remote host. If not specified, JetBrains Fleet will open an empty workspace on the host.

  • forceNewHost (optional): A boolean value (true or false). The default is false. Setting this to true will force JetBrains Fleet to ignore previous known hosts and establish a new connection each time.

SSH URI syntax

You can specify the username and port using the common SSH URI syntax directly in the hostname section of the URI. For example:

fleet://fleet.ssh/foo@example.org:2222

On macOS, the format is the following:

open "fleet://fleet.ssh/foo@example.org:2222"

Default behavior

If some parameters are not specified, JetBrains Fleet will attempt to use the closest known match from previous connections or revert to default values. The .ssh/config file is considered when connecting.

If you do not specify pwd, JetBrains Fleet will open an empty workspace on the host.

Examples

Below are examples demonstrating how to use the JetBrains Fleet URI handler to connect to SSH hosts:

  • Connecting with a username and working directory:

    fleet://fleet.ssh/example.org?username=foo&pwd=/home/foo/my_test_project

    This example connects to example.org with the username foo and opens the /home/foo/my_test_project directory.

  • Connecting with a username in the hostname:

    fleet://fleet.ssh/foo@example.org?pwd=/home/foo/my_test_project

    This connects to example.org with the username foo and sets the working directory to /home/foo/my_test_project.

Additional notes

  • Only the hostname parameter is required. Other parameters are optional but can enhance the connection experience by pre-configuring specific settings.

  • Always ensure that URIs are properly formatted to prevent connection issues.

  • When using forceNewHost=true, note that this will override any existing known host configurations, forcing a fresh connection setup each time.

Last modified: 12 August 2024
InstallationUninstall