scp-next 1.0.13 → 1.0.14

package/CHANGELOG.md

@@ -1,7 +1,12 @@
 # Changelog
 
-## 0.1.0
+## 1.0.14
 
-- Initial `scp-next` TypeScript CLI and library.
+- Production-ready `scp-next` TypeScript CLI and library.
 - Added upload, download, recursive directory transfer, dry-run mode, configuration files,
   profiles, jobs, environment-variable support, typed errors, and dual ESM/CommonJS builds.
+- Added GitHub Pages developer documentation and expanded README usage sections.
+- Improved SCP-style destination handling for files and directories.
+- Enabled destination directory creation by default with `--no-create-directories` opt-out.
+- Improved host verification guidance, Git Bash remote path handling, and progress output behavior.
+- Removed unused legacy tooling and Docker configuration files.

package/README.md

@@ -19,6 +19,14 @@
 It uses SFTP internally through `ssh2-sftp-client` instead of implementing SCP or SFTP protocols manually.
 Developer documentation is available at <https://chengchuu.github.io/scp-next/>.
 
+## Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Basic Usage](#basic-usage)
+- [Library Usage](#library-usage)
+- [Advanced Usage](#advanced-usage)
+
 ## Features
 
 - Upload and download files or directories recursively.
@@ -200,6 +208,28 @@ try {
 }
 ```
 
+### Use a Configuration File
+
+The CLI loads configuration files automatically. The library API receives options directly,
+so load JSON in your application and pass the relevant `server` and `transfer` values.
+
+```ts
+import { readFile } from "node:fs/promises";
+
+import { upload, type ScpNextConfig } from "scp-next";
+
+const config = JSON.parse(
+  await readFile(new URL("./scp-next.config.json", import.meta.url), "utf8")
+) as ScpNextConfig;
+
+await upload({
+  ...config.server,
+  ...config.transfer,
+  localPath: "./dist",
+  remotePath: "/var/www/example"
+});
+```
+
 ## Advanced Usage
 
 ### Configuration Files
@@ -218,6 +248,14 @@ Use `--config` for an explicit path:
 scp-next upload ./dist /var/www/example --config ./deploy/scp-next.json
 ```
 
+Use `--profile` with a configuration file:
+
+```bash
+scp-next upload ./dist /var/www/example \
+  --config ./scp-next.config.json \
+  --profile production
+```
+
 Example:
 
 ```json
@@ -237,6 +275,19 @@ Example:
 }
 ```
 
+Configuration file options:
+
+| Key              | Description                                                         |
+| ---------------- | ------------------------------------------------------------------- |
+| `server`         | SSH connection options such as `host`, `port`, and `username`.      |
+| `transfer`       | Transfer defaults such as `recursive`, `overwrite`, and `timeout`.  |
+| `defaultProfile` | Profile name used when `--profile` or `SCP_NEXT_PROFILE` is absent. |
+| `profiles`       | Named server connection profiles.                                   |
+| `jobs`           | Reusable upload or download jobs for `scp-next run <job>`.          |
+
+Root-level server options such as `host`, `username`, `privateKeyFile`, `knownHostsFile`,
+and `hostFingerprint` are also supported for simple configuration files, but `server` keeps connection values grouped and easier to read.
+
 ### Named Profiles
 
 ```json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scp-next",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "A SCP CLI and library for secure SSH file transfers using SFTP.",
   "type": "module",
   "main": "./dist/index.cjs",