scp-next 1.0.16 → 1.0.17

package/README.md

@@ -70,6 +70,9 @@ scp-next download /var/log/example.log ./logs/example.log \
   --password your-password
 ```
 
+Password arguments are convenient, but they may be exposed through shell history and process listings.
+Prefer `SCP_NEXT_PASSWORD`, SSH agents, or protected private-key files for shared or production environments.
+
 Use the library:
 
 ```ts
@@ -108,44 +111,66 @@ Destination paths follow familiar `cp`/`scp` behavior. If the destination exists
 
 ### Upload Examples
 
-Password authentication:
+Preview a recursive deploy before connecting:
 
 ```bash
 scp-next upload ./dist /var/www/example \
   --host your-host \
   --username your-username \
   --password your-password \
-  --recursive
+  --recursive \
+  --dry-run
+```
+
+Deploy with overwrite and verbose diagnostics:
+
+```bash
+scp-next upload ./dist /var/www/example \
+  --host your-host \
+  --username your-username \
+  --password your-password \
+  --recursive \
+  --overwrite \
+  --verbose
 ```
 
-Private-key authentication:
+Use an encrypted private key:
 
 ```bash
 scp-next upload ./dist /var/www/example \
   --host your-host \
   --username your-username \
   --private-key-file ~/.ssh/id_ed25519 \
+  --passphrase your-passphrase \
   --recursive
 ```
 
 ### Download Examples
 
-Password authentication:
+Download a remote directory recursively:
 
 ```bash
-scp-next download /var/log/example.log ./logs/example.log \
+scp-next download /var/log/example ./logs/example \
   --host your-host \
   --username your-username \
-  --password your-password
+  --password your-password \
+  --recursive
 ```
 
-Private-key authentication:
+Download and overwrite an existing local file:
 
 ```bash
 scp-next download /var/log/example.log ./logs/example.log \
   --host your-host \
   --username your-username \
-  --private-key-file ~/.ssh/id_ed25519
+  --password your-password \
+  --overwrite
+```
+
+Run a configured download job:
+
+```bash
+scp-next run download-logs --config ./scp-next.config.json
 ```
 
 ### CLI Options
@@ -257,12 +282,10 @@ await upload({
 
 ### Configuration Files
 
-`scp-next` searches for these files in the current directory:
+Use `scp-next.config.json` in the current directory. `scp-next` also auto-detects these rc-style filenames: `.scp-nextrc`, `.scp-nextrc.json`.
 
 ```text
 scp-next.config.json
-.scp-nextrc
-.scp-nextrc.json
 ```
 
 Use `--config` for an explicit path:
@@ -298,6 +321,8 @@ Example:
 }
 ```
 
+Do not commit configuration files containing real passwords. Prefer `SCP_NEXT_PASSWORD` or another protected secret source for shared repositories and deployment environments.
+
 Configuration file options:
 
 | Key              | Description                                                         |
@@ -396,7 +421,7 @@ Bash:
 ```bash
 export SCP_NEXT_HOST="your-host"
 export SCP_NEXT_USERNAME="your-username"
-export SCP_NEXT_PRIVATE_KEY_FILE="$HOME/.ssh/id_ed25519"
+export SCP_NEXT_PASSWORD="your-password"
 scp-next upload ./dist /var/www/example --recursive
 ```
 
@@ -405,7 +430,7 @@ PowerShell:
 ```powershell
 $env:SCP_NEXT_HOST = "your-host"
 $env:SCP_NEXT_USERNAME = "your-username"
-$env:SCP_NEXT_PRIVATE_KEY_FILE = "$HOME\.ssh\id_ed25519"
+$env:SCP_NEXT_PASSWORD = "your-password"
 scp-next upload .\dist /var/www/example --recursive
 ```
 

package/package.json

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