Read the documentation

@jalsoedesign/filezilla-core

Read saved FileZilla sites in JavaScript or TypeScript. Find profiles by name, host, username or other connection details, access saved credentials, and decode remote directory paths.

Read and query FileZilla sitemanager.xml files from TypeScript or JavaScript projects.

Install

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

npm install @jalsoedesign/filezilla-core

Quick Start

import {getDefaultSiteManager} from '@jalsoedesign/filezilla-core';

// Automatically finds sitemanager.xml on Windows, macOS, or Linux
const siteManager = getDefaultSiteManager();

const site = siteManager.getServerByPath('Production/Web Server');

if (site) {
    console.log(site.properties.host);       // e.g. web.example.com
    console.log(site.getRemoteDirectory());  // e.g. /var/www/html
}

Search profiles

const matches = siteManager.searchServers('example.com', {fields: 'all'});

All-fields search checks every loaded property, including passwords, plus the site path, protocol name and decoded remote directory. Omit the options to search only site names and folder paths. Search does not load additional credentials.

For terminal searches, install the CLI and run filezilla-js --search example.com --show-password.

Features

• TypeScript First: Full type safety included.
• Auto-discovery: Automatically finds the FileZilla configuration on all major OSs.
• Path Resolution: Converts FileZilla's internal directory format into standard paths.
• Passwords: Decodes supported plain/base64 credentials when requested; JSON projections redact passwords.
• Import reports: Optional tolerant mode returns independent valid sites and redacted diagnostics.
• Identity and metadata: Explicit stable-ID reconciliation plus versioned immutable snapshots and precise diffs.

Connectors

While @jalsoedesign/filezilla-core handles the configuration parsing, you can use the dedicated connectors to interact with the files:

• @jalsoedesign/filezilla-connector-ftp - High-level API for FTP, FTPS, and FTPES.
• @jalsoedesign/filezilla-connector-sftp - High-level API for SFTP.

Documentation

Detailed API documentation and references:

• Import workflows - Report defaults, identity conflicts, persistence ownership and metadata profiles.

• Extended API Documentation - Detailed classes and methods.

• Enums Reference - ServerProtocol, LogonType, etc.

• Types Reference - Raw interfaces and types with descriptions.

Testing

To run the core library tests:

npm test

License

MIT © JalsoeDesign