Read the documentation

@jalsoedesign/filezilla-cli

Find saved FileZilla connection details from your terminal. Search by site name, IP address, username or any other saved field, display matching profiles, and copy individual values into scripts.

Command-line interface for querying FileZilla sitemanager.xml files and optionally checking a connection without remote mutations. Metadata queries use @jalsoedesign/filezilla-core; the opt-in check uses the public FTP/SFTP connectors.

Why

Connection details already live in FileZilla. This CLI lets you query them directly from the terminal, making it easy to pipe host names, users, or passwords into scripts and automation without copying values by hand.

Install

Use Node ^22.22.2 || ^24.15.0 || >=26.0.0. Install from the public npm registry.

npm install -g @jalsoedesign/filezilla-cli

Quick start

Search your usual FileZilla configuration; the CLI finds it automatically on Windows, macOS and Linux.

filezilla-js --search clientName --show-password
filezilla-js --search 10.2.3.4 --show-password
filezilla-js search admin-user --json

Each match gets a Label/Value table with Name, Path, Protocol, Host, Port, Username, Password and Remote. Passwords are hidden unless you pass --show-password. Use --file <path> to search another Site Manager XML file.

Search matches a case-insensitive substring across all loaded fields, including passwords, comments, local directories and decoded remote directories. It does not connect to the servers. JSON output is an array, including [] when nothing matches. The existing list --search and get --search options search names and folder paths.

List all sites

filezilla-js list --json

[
  {
    "path": "SFTP (root location)",
    "host": "test.rebex.net",
    "protocol": "SFTP"
  },
  {
    "path": "Rebex/SFTP",
    "host": "test.rebex.net",
    "protocol": "SFTP"
  }
]

Get specific site details

filezilla-js get "Rebex/FTP" --json

{
  "path": "Rebex/FTP",
  "host": "test.rebex.net",
  "port": 21,
  "protocol": 6,
  "protocolName": "INSECURE_FTP",
  "user": "demo",
  "password": "(hidden)",
  "remoteDirectory": "/pub/example"
}

Documentation

For detailed information on all flags, output formats (Table, Generic), and error handling, see the Extended Documentation.

Testing

To run the CLI tests:

npm test

Commands

list

Lists all servers in the FileZilla configuration.

filezilla-js list [--file <path>] [--json] [--table] [--search <term>] [--recurse] [--full] [--show-password]

Example: Recursive JSON output

filezilla-js list --json --recurse

{
  "name": "Root",
  "folders": [
    {
      "name": "Rebex",
      "folders": [],
      "servers": [
        {
          "path": "Rebex/SFTP",
          "host": "test.rebex.net",
          "port": 22,
          "protocol": 1,
          "protocolName": "SFTP",
          "user": "demo",
          "password": "(hidden)"
        }
      ]
    }
  ],
  "servers": []
}

get

Retrieves details for a specific server, or a single property value.

filezilla-js get <path> [property] [--file <path>] [--json] [--table] [--search <term>] [--show-password]

Example: Get as JSON

filezilla-js get "Rebex/FTP" --json

{
  "path": "Rebex/FTP",
  "host": "test.rebex.net",
  "port": 21,
  "protocol": 6,
  "protocolName": "INSECURE_FTP",
  "user": "demo",
  "password": "(hidden)",
  "remoteDirectory": "/pub/example"
}

More Examples (JSON)

List as JSON (Summary)

filezilla-js list --file packages/core/fixtures/general/sitemanager.multi.xml --json

[
  {
    "path": "SFTP (root location)",
    "host": "test.rebex.net",
    "protocol": "SFTP"
  },
  {
    "path": "Rebex/SFTP",
    "host": "test.rebex.net",
    "protocol": "SFTP"
  }
]

Get as JSON (Full)

filezilla-js get "SFTP (root location)" --file packages/core/fixtures/general/sitemanager.multi.xml --json

{
  "path": "SFTP (root location)",
  "host": "test.rebex.net",
  "port": 22,
  "protocol": 1,
  "type": 0,
  "user": "demo",
  "password": "(hidden)",
  "logonType": 1,
  "timezoneOffset": 0,
  "passiveMode": 0,
  "maximumMultipleConnections": 0,
  "encodingType": 2,
  "bypassProxy": false,
  "name": "SFTP (root location)",
  "comments": "",
  "localDirectory": "",
  "remoteDirectory": "",
  "synchronizedBrowsing": false,
  "directoryComparison": false,
  "protocolName": "SFTP"
}

Read-only connection check and recipes

filezilla-js check "Production" --file ./sites.xml --host-key-sha256 <verified-pin> --json uses an exact site selection and independently verified SFTP trust. Passwords come from the selected site or redirected --password-stdin; there is no password argument or automatic trust approval. --directory and --include-listing enable optional metadata work.

See connection checks for strict flags, deadlines, cleanup results and stable exit codes. Existing list/get parsing and output are unchanged. The package also includes typed transfer recipes in examples/transfer-recipes.ts; these are application source examples, not CLI transfer commands.

License

MIT © JalsoeDesign