Configuration

Getting started

Default configuration

A deafult configuration is provided with the application. You don’t need to change it unless you explicitly need to change some of the apsects desribed below.

Beware, the application may write to the configuration file as you use it (e.g., when you change the settings within the application itself).

Configuration file

Location

You configuration file location depends on your OS. To navigate to it, use the “Show the configuration directory” command from the Command Palette (Ctrl+p).

Bookmarks

Bookmarks are defined under bookmarks.paths as a plain list of local paths:

"bookmarks": {
  "paths": [
    "~",
    "~/Documents",
    "~/Downloads",
    "~/Pictures",
    "~/Videos",
    "~/Music"
  ]
}

By default, bookmarks are set to the typical desktop locations, similar to the example above.

Remote file systems

Connection configuration is defined under file_systems, as a list of connection objects. Each connection object defines:

  • display_name: a title that will be shown in the bookmarks list
  • protocol: a name of the protocol recognized by fsspec
  • path: an optional default path to navigate to upon connecting (defaults to root)
  • other keys are considered to be fsspec storage_options (see https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.filesystem)

Refer to the documentation of the installed additional packages for more information about the remote file system configuration.

For example, to connect to an ADLS Gen2 storage account:

"file_systems": [
  {
    "display_name": "My BLOB storage",
    "protocol": "abfs",
    "params": {
      "account_name": "myaccount",
      "account_key": "mykey"
    }
  }
]

To connect to a remote file system you may need to install additional packages that provide fsspec implementations for the desired protocol. To find the name of the package, if it is missing, use the “Connect” dialog (Ctrl+t).

For example, if you installed F2 Commander with pipx, and you want to connect to an S3 bucket, you need to install the s3fs package:

pipx inject f2-commander s3fs

Color themes

To change a color theme, select “Change theme” from the Command Palette.

Themes are built-in and are currently not customizable.