Ver código fonte

chore(doc) update api key usage for CLI tool

Alex Tran 2 anos atrás
pai
commit
d1d69bfaf4

+ 12 - 6
docs/docs/features/bulk-upload.md

@@ -20,7 +20,7 @@ npm i -g immich
 Specify user's credentials, Immich's server address and port, and the directory you would like to upload videos/photos from.
 
 ```bash
-immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d your/target/directory
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d your/target/directory
 ```
 
 ---
@@ -31,26 +31,32 @@ immich upload --email testuser@email.com --password password --server http://192
 | ---------------- | ------------------------------------------------------------------- |
 | --yes / -y       | Assume yes on all interactive prompts                               |
 | --delete / -da   | Delete local assets after upload                                    |
-| --email / -e     | User's email                                                        |
-| --password / -pw | User's password                                                     |
+| --key / -k       | User's API key                                                      |
 | --server / -s    | Immich's server address                                             |
 | --directory / -d | Directory to upload from                                            |
 | --threads / -t   | Number of threads to use (Default 5)                                |
 | --album/ -al     | Create albums for assets based on the parent folder or a given name |
 
+### Obtain the API Key
+
+The API key can be obtained in the user setting panel on the web interface.
+
+![Obtain Api Key](./img/obtain-api-key.png)
+
+
 ### Run via Docker
 
 Be aware that as this runs inside a container it mounts your current directory as a volume, and for the -d flag you need to use the path inside the container.
 
 ```bash
-docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import
+docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d /import
 ```
 
 Optionally, you can create an alias:
 
 ```bash
 alias immich="docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest"
-immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import
+immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d /import
 ```
 
 ### Run from source
@@ -68,5 +74,5 @@ npm run build
 ```
 
 ```bash title="Run the command"
-node bin/index.js upload --email testuser@email.com --password password --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 -d your/target/directory
 ```

BIN
docs/docs/features/img/obtain-api-key.png