@jalsoedesign/filezilla-cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 filezilla-js contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,206 @@
+**[Read the documentation](https://h2ooooooo.github.io/filezilla-js/)**
+
+# @jalsoedesign/filezilla-cli
+
+The network check and connector recipes now use Dockline through the FileZilla settings bridges. FileZilla owns reading/selection and host-key import; the separate Dockline FTP/SFTP packages own transport. The CLI remains `list`, `get`, and read-only `check`.
+
+[![npm version](https://img.shields.io/npm/v/@jalsoedesign/filezilla-cli.svg)](https://www.npmjs.com/package/@jalsoedesign/filezilla-cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/h2ooooooo/filezilla-js/actions/workflows/ci.yml/badge.svg)](https://github.com/h2ooooooo/filezilla-js/actions/workflows/ci.yml)
+
+Command-line interface for querying FileZilla `sitemanager.xml` files and optionally checking a connection without remote mutations. Metadata queries use [`@jalsoedesign/filezilla-core`](../core/README.md); 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.
+
+```bash
+npm install -g @jalsoedesign/filezilla-cli
+```
+
+## Quick start
+
+Get FileZilla sites as JSON with a single command.
+
+### List all sites
+```bash
+filezilla-js list --json
+```
+```json
+[
+  {
+    "path": "SFTP (root location)",
+    "host": "test.rebex.net",
+    "protocol": "SFTP"
+  },
+  {
+    "path": "Rebex/SFTP",
+    "host": "test.rebex.net",
+    "protocol": "SFTP"
+  }
+]
+```
+
+### Get specific site details
+```bash
+filezilla-js get "Rebex/FTP" --json
+```
+```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](https://github.com/h2ooooooo/filezilla-js/blob/main/packages/cli/docs/extended.MD).
+
+## Testing
+
+To run the CLI tests:
+
+```bash
+npm test
+```
+
+## Commands
+
+### `list`
+
+Lists all servers in the FileZilla configuration.
+
+```bash
+filezilla-js list [--file <path>] [--json] [--table] [--search <term>] [--recurse] [--full] [--show-password]
+```
+
+**Example: Recursive JSON output**
+
+```bash
+filezilla-js list --json --recurse
+```
+
+```json
+{
+  "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.
+
+```bash
+filezilla-js get <path> [property] [--file <path>] [--json] [--table] [--search <term>] [--show-password]
+```
+
+**Example: Get as JSON**
+
+```bash
+filezilla-js get "Rebex/FTP" --json
+```
+
+```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)
+
+```bash
+filezilla-js list --file packages/core/fixtures/general/sitemanager.multi.xml --json
+```
+
+```json
+[
+  {
+    "path": "SFTP (root location)",
+    "host": "test.rebex.net",
+    "protocol": "SFTP"
+  },
+  {
+    "path": "Rebex/SFTP",
+    "host": "test.rebex.net",
+    "protocol": "SFTP"
+  }
+]
+```
+
+### Get as JSON (Full)
+
+```bash
+filezilla-js get "SFTP (root location)" --file packages/core/fixtures/general/sitemanager.multi.xml --json
+```
+
+```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](https://h2ooooooo.github.io/filezilla-js/guide/connection-check.html) 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](https://h2ooooooo.github.io/filezilla-js/guide/transfer-recipes.html) in `examples/transfer-recipes.ts`; these are application source examples, not CLI transfer commands.
+
+## License
+
+MIT © [JalsoeDesign](https://www.jalsoedesign.net)

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+// Force color on Windows by default if we are in a TTY to avoid messing up pipes
+const args = process.argv.slice(2);
+if (args.includes('--color')) {
+    process.env.FORCE_COLOR = '1';
+}
+else if (args.includes('--no-color')) {
+    process.env.FORCE_COLOR = '0';
+}
+else if (process.platform === 'win32' && process.env.FORCE_COLOR === undefined && process.stdout.isTTY) {
+    process.env.FORCE_COLOR = '1';
+}
+import { run } from './index.js';
+run().catch(err => {
+    console.error(err);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,iFAAiF;AACjF,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC;AAClC,CAAC;KAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IACrC,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC;AAClC,CAAC;KAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACvG,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC;AAClC,CAAC;AAED,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAE/B,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;IACd,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC"}

package/dist/commands/check.d.ts

@@ -0,0 +1,33 @@
+import { type Server } from '@jalsoedesign/filezilla-core';
+import { type ConnectionStage } from '@jalsoedesign/filezilla-connector-abstract';
+export type ConnectionCheckStage = ConnectionStage | 'input' | 'list' | 'cleanup';
+export type ConnectionCheckStatus = 'ok' | 'invalid-options' | 'trust-rejected' | 'authentication-failed' | 'unsupported-protocol' | 'connection-failed' | 'directory-failed' | 'credentials-required' | 'invalid-site' | 'cleanup-failed' | 'listing-limit' | 'cancelled' | 'timeout';
+export interface ConnectionCheckResult {
+    readonly schemaVersion: 1;
+    readonly ok: boolean;
+    readonly status: ConnectionCheckStatus;
+    readonly exitCode: number;
+    readonly stage: ConnectionCheckStage;
+    readonly message: string;
+    readonly connected: boolean;
+    readonly directoryChecked: boolean;
+    readonly cleanup: 'not-required' | 'closed' | 'failed';
+    readonly listing?: readonly {
+        readonly path: string;
+        readonly type: string;
+        readonly size?: number;
+    }[];
+}
+export interface ConnectionCheckOptions {
+    readonly hostKeySha256?: string;
+    readonly password?: string;
+    readonly directory?: string;
+    readonly includeListing?: boolean;
+    readonly timeoutMs?: number;
+    readonly maxEntries?: number;
+    readonly abortSignal?: AbortSignal;
+}
+/** Ordinary read-only connector operations with fixed, credential-free result messages. */
+export declare function checkConnection(server: Server, options?: ConnectionCheckOptions): Promise<ConnectionCheckResult>;
+export declare function runCheckCommand(args: string[]): Promise<void>;
+//# sourceMappingURL=check.d.ts.map

package/dist/commands/check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAGA,OAAO,EAA4C,KAAK,MAAM,EAAC,MAAM,8BAA8B,CAAC;AAGpG,OAAO,EAaH,KAAK,eAAe,EAGvB,MAAM,4CAA4C,CAAC;AAEpD,MAAM,MAAM,oBAAoB,GAAG,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;AAClF,MAAM,MAAM,qBAAqB,GAAG,IAAI,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,uBAAuB,GACrG,sBAAsB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,sBAAsB,GAC1F,cAAc,GAAG,gBAAgB,GAAG,eAAe,GAAG,WAAW,GAAG,SAAS,CAAC;AAElF,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;IAC1B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IACvC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;CACxG;AAED,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;CACtC;AAsMD,2FAA2F;AAC3F,wBAAsB,eAAe,CACjC,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,sBAA2B,GACrC,OAAO,CAAC,qBAAqB,CAAC,CA2GhC;AAyHD,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA4EnE"}