github/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-06-07 23:01:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): Clarify the usage of immich-cli with Docker (#17595)

Browse Source 
Add some explanation how to use the various usage parameters together
with the `immich-cli` in the container.
This commit is contained in:
Paul Puschmann 2025-04-15 22:08:55 +02:00 committed by GitHub
parent 36fa61c013
commit 459c815086
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/features/command-line-interface.md
View File

@ -42,6 +42,12 @@ docker run -it -v "$(pwd)":/import:ro -e IMMICH_INSTANCE_URL=https://your-immich
Please modify the `IMMICH_INSTANCE_URL` and `IMMICH_API_KEY` environment variables as suitable. You can also use a Docker env file to store your sensitive API key.
This `docker run` command will directly run the command `immich` inside the container. You can directly append the desired parameters (see under "usage") to the commandline like this:
```bash
docker run -it -v "$(pwd)":/import:ro -e IMMICH_INSTANCE_URL=https://your-immich-instance/api -e IMMICH_API_KEY=your-api-key ghcr.io/immich-app/immich-cli:latest upload -a -c 5 --recursive directory/
```
## Usage
<details>