|
@@ -17,23 +17,29 @@ npm i -g immich
|
|
|
|
|
|
## Quick Start
|
|
## Quick Start
|
|
|
|
|
|
-Specify user's credentials, Immich's server address and port, and the directory you would like to upload videos/photos from.
|
|
|
|
|
|
+Specify user's credential, Immich's server address and port and the directory you would like to upload videos/photos from.
|
|
|
|
|
|
-```bash
|
|
|
|
-immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d your/target/directory
|
|
|
|
|
|
+```
|
|
|
|
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api file1.jpg file2.jpg
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+By default, subfolders are not included. To upload a directory including subfolder, use the --recursive option:
|
|
|
|
+
|
|
|
|
+```
|
|
|
|
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive directory/
|
|
```
|
|
```
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
-### Parameters
|
|
|
|
|
|
+### Options
|
|
|
|
|
|
| Parameter | Description |
|
|
| Parameter | Description |
|
|
| ---------------- | ------------------------------------------------------------------- |
|
|
| ---------------- | ------------------------------------------------------------------- |
|
|
| --yes / -y | Assume yes on all interactive prompts |
|
|
| --yes / -y | Assume yes on all interactive prompts |
|
|
|
|
+| --recursive / -r | Include subfolders |
|
|
| --delete / -da | Delete local assets after upload |
|
|
| --delete / -da | Delete local assets after upload |
|
|
| --key / -k | User's API key |
|
|
| --key / -k | User's API key |
|
|
| --server / -s | Immich's server address |
|
|
| --server / -s | Immich's server address |
|
|
-| --directory / -d | Directory to upload from |
|
|
|
|
| --threads / -t | Number of threads to use (Default 5) |
|
|
| --threads / -t | Number of threads to use (Default 5) |
|
|
| --album/ -al | Create albums for assets based on the parent folder or a given name |
|
|
| --album/ -al | Create albums for assets based on the parent folder or a given name |
|
|
|
|
|
|
@@ -92,5 +98,5 @@ npm run build
|
|
```
|
|
```
|
|
|
|
|
|
```bash title="Run the command"
|
|
```bash title="Run the command"
|
|
-node bin/index.js upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d your/target/directory
|
|
|
|
|
|
+node bin/index.js upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive your/asset/directory
|
|
```
|
|
```
|