Infrastructure/immich
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-01-07 00:50:23 -05:00
Code Issues Activity

Document cli path parameter (#2011)

Browse source
This commit is contained in:
Jonathan Jogenfors 2023-03-18 22:11:02 +01:00 committed by GitHub
parent 05cf5d57a9
commit d7bfab7b13
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/docs/features/bulk-upload.md
View file

@ -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
``` ```