mirror of
https://github.com/immich-app/immich.git
synced 2025-11-23 16:50:54 +09:00
02994883fe
Some checks failed
CLI Build / CLI Publish (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Docker / pre-job (push) Has been cancelled
Docs build / pre-job (push) Has been cancelled
Static Code Analysis / pre-job (push) Has been cancelled
Static Code Analysis / zizmor (push) Has been cancelled
Test / pre-job (push) Has been cancelled
Test / ShellCheck (push) Has been cancelled
Test / OpenAPI Clients (push) Has been cancelled
Test / TypeORM Checks (push) Has been cancelled
CLI Build / Docker (push) Has been cancelled
Docker / Re-Tag ML () (push) Has been cancelled
Docker / Re-Tag ML (-armnn) (push) Has been cancelled
Docker / Re-Tag ML (-cuda) (push) Has been cancelled
Docker / Re-Tag ML (-openvino) (push) Has been cancelled
Docker / Re-Tag ML (-rknn) (push) Has been cancelled
Docker / Re-Tag ML (-rocm) (push) Has been cancelled
Docker / Re-Tag Server () (push) Has been cancelled
Docker / Build and Push ML (armnn, linux/arm64, ubuntu-24.04-arm, -armnn) (push) Has been cancelled
Docker / Build and Push ML (cpu, linux/amd64, ubuntu-latest) (push) Has been cancelled
Docker / Build and Push ML (cpu, linux/arm64, ubuntu-24.04-arm) (push) Has been cancelled
Docker / Build and Push ML (cuda, linux/amd64, ubuntu-latest, -cuda) (push) Has been cancelled
Docker / Build and Push ML (openvino, linux/amd64, ubuntu-latest, -openvino) (push) Has been cancelled
Docker / Build and Push ML (rknn, linux/arm64, ubuntu-24.04-arm, -rknn) (push) Has been cancelled
Docker / Build and Push ML (rocm, linux/amd64, mich, -rocm) (push) Has been cancelled
Docker / Merge & Push ML (armnn, -armnn) (push) Has been cancelled
Docker / Merge & Push ML (cpu) (push) Has been cancelled
Docker / Merge & Push ML (cuda, -cuda) (push) Has been cancelled
Docker / Merge & Push ML (openvino, -openvino) (push) Has been cancelled
Docker / Merge & Push ML (rknn, -rknn) (push) Has been cancelled
Docker / Merge & Push ML (rocm, -rocm) (push) Has been cancelled
Docker / Build and Push Server (linux/amd64, ubuntu-latest) (push) Has been cancelled
Docker / Build and Push Server (linux/arm64, ubuntu-24.04-arm) (push) Has been cancelled
Docker / Merge & Push Server (push) Has been cancelled
Docker / Docker Build & Push Server Success (push) Has been cancelled
Docker / Docker Build & Push ML Success (push) Has been cancelled
Docs build / Docs Build (push) Has been cancelled
Static Code Analysis / Run Dart Code Analysis (push) Has been cancelled
Test / Test & Lint Server (push) Has been cancelled
Test / Unit Test CLI (push) Has been cancelled
Test / Unit Test CLI (Windows) (push) Has been cancelled
Test / Lint Web (push) Has been cancelled
Test / Test Web (push) Has been cancelled
Test / End-to-End Lint (push) Has been cancelled
Test / Medium Tests (Server) (push) Has been cancelled
Test / End-to-End Tests (Server & CLI) (push) Has been cancelled
Test / End-to-End Tests (Web) (push) Has been cancelled
Test / Unit Test Mobile (push) Has been cancelled
Test / Unit Test ML (push) Has been cancelled
Test / .github Files Formatting (push) Has been cancelled
A command-line interface for interfacing with the self-hosted photo manager Immich.
Please see the Immich CLI documentation.
For developers
Before building the CLI, you must build the immich server and the open-api client. To build the server run the following in the server folder:
$ npm install
$ npm run build
Then, to build the open-api client run the following in the open-api folder:
$ ./bin/generate-open-api.sh
To run the Immich CLI from source, run the following in the cli folder:
$ npm install
$ npm run build
$ ts-node .
You'll need ts-node, the easiest way to install it is to use npm:
$ npm i -g ts-node
You can also build and install the CLI using
$ npm run build
$ npm install -g .