CLI

@jalsoedesign/filezilla-cli searches your saved FileZilla profiles and displays connection details in the terminal. It finds your usual Site Manager file automatically; use --file to read another XML file. The check command can also test a saved connection.

filezilla-js --search clientName --show-password
filezilla-js search 10.2.3.4 --json
filezilla-js list --file ./sitemanager.xml
filezilla-js list --file ./sitemanager.xml --full
filezilla-js list --file ./sitemanager.xml --table --full
filezilla-js list --file ./sitemanager.xml --json --recurse
filezilla-js get "Production/Web" host --file ./sitemanager.xml
filezilla-js get --search "unique site" protocolName --file ./sitemanager.xml

Quote paths/search terms containing spaces. Exact selection uses case-sensitive canonical paths; literal percent/slash within names are escaped as described in querying. get --search requires exactly one match.

Search profiles

filezilla-js --search <term> and filezilla-js search <term> perform the same all-fields search. Matching is a case-insensitive substring across all loaded property values, the canonical site path and the protocol name. This includes hosts, ports, usernames, loaded passwords, comments, key files and local directories. Remote directories are searched in both encoded and decoded form when decoding is supported.

The default output shows a count and one Label/Value table per match: Name, Path, Protocol, Host, Port, Username, Password and Remote. Passwords stay hidden unless --show-password is supplied. An unsupported remote directory is shown in its encoded form with a note, without preventing other results from appearing.

--json returns an array of profiles with path, name, protocol (display name), host, port, user, password and remoteDirectory. No matches returns [] in JSON or Found 0 servers in text, with exit code 0. An empty quoted term matches every profile. --full and --recurse are list-only options.

list --search and get --search keep their name/path matching. Searching reads local configuration and does not contact any server.

Query options

Option	Meaning
--file path	Explicit XML file; otherwise automatic discovery
--search term	All fields without a command; canonical path/site name with list/get
--json	JSON; takes precedence over table
--table	Terminal table
--full	Full properties for plain, table and JSON flat lists
--recurse	Nested list tree; requires JSON
--show-password	Explicitly reveal supported loaded passwords
--help, -h	Help without reading XML
--color, --no-color	The executable sets FORCE_COLOR before command execution; ordinary Chalk environment behavior also applies

Query output

Invocation	Shape
list	Bulleted canonical paths
list --json	{path, host, protocol} array; protocol is display name
list --full	Full key/value records, including protocolName
list --table	Path, Host, Protocol
list --table --full	Path, Property, Value rows
list --json --full	Full properties with numeric protocol and protocolName
list --json --recurse	Root/folders/servers tree; full records
get path	Full key/value properties
get path --json	Full properties plus protocolName
get path host --json	JSON scalar

Full list/get output decodes remoteDirectory, so an unsupported saved path can still reject full/path output. Compact lists, host/name queries and list/get searches do not decode it. Profile search attempts decoding and falls back to the encoded value. R2 displays as CLOUDFLARE_R2. Passwords are (hidden) unless explicitly requested; query commands load credentials before masking them. The check command requests only its selected credential.

Query errors and automation

Ordinary failures use stderr and exit 1; JSON mode emits {error: message} for handled command failures. Unknown-command handling still prints plain error/help even with JSON. Without a command or --search, the CLI prints help and exits successfully.

Unknown flags are ignored; missing flag values are not comprehensively rejected, and there is no -- terminator. --search requires a value. Validate arguments in automation rather than relying on permissive parsing.

The exported run(): Promise<void> reads process arguments, writes the console and may exit. Use core for embedded metadata queries.

Read-only connection checks

filezilla-js check <canonical-path> --file <xml> --host-key-sha256 <pin> --json runs ordinary connector operations and closes the connection. SFTP requires independently verified pinning; FTP retains normal TLS certificate verification. --password-stdin accepts redirected credentials without putting secrets in argv.

--directory requests a metadata check; --include-listing requests a shallow listing bounded by --max-entries. --timeout-ms covers credentials and network work. Unlike legacy query parsing, check rejects unknown/invalid flags and writes versioned JSON outcomes to stdout with documented status-specific exit codes. It does not accept query-only flags such as --show-password, --table, --search or color flags.

The package also exports checkConnection(server, options): Promise<ConnectionCheckResult> and its option/result types. See connection checks for the complete flags, security boundary, cleanup state and exit-code table. Packaged transfer recipes are executable source examples; they are not CLI transfer commands.