mirror of
https://github.com/immich-app/immich.git
synced 2026-07-05 20:57:40 +00:00
f77c8a4699
Some checks failed
CodeQL / Analyze (push) Waiting to run
Docker / Build and Push ML (push) Blocked by required conditions
Docker / pre-job (push) Waiting to run
Docker / Re-Tag ML (push) Blocked by required conditions
Docker / Re-Tag Server (push) Blocked by required conditions
Docker / Build and Push Server (push) Blocked by required conditions
Docker / Docker Build & Push Server Success (push) Blocked by required conditions
Docker / Docker Build & Push ML Success (push) Blocked by required conditions
Docs build / pre-job (push) Waiting to run
Docs build / Docs Build (push) Blocked by required conditions
Zizmor / Zizmor (push) Waiting to run
Static Code Analysis / pre-job (push) Waiting to run
Static Code Analysis / Run Dart Code Analysis (push) Blocked by required conditions
Test / pre-job (push) Waiting to run
Test / Scripts unit tests (push) Blocked by required conditions
Test / Test & Lint Server (push) Blocked by required conditions
Test / Unit Test CLI (push) Blocked by required conditions
Test / Unit Test CLI (Windows) (push) Blocked by required conditions
Test / Lint Web (push) Blocked by required conditions
Test / Test Web (push) Blocked by required conditions
Test / Test i18n (push) Blocked by required conditions
Test / End-to-End Lint (push) Blocked by required conditions
Test / Medium Tests (Server) (push) Blocked by required conditions
Test / End-to-End Tests (Server & CLI) (push) Blocked by required conditions
Test / Unit Test ML (push) Blocked by required conditions
Test / End-to-End Tests (Web) (push) Blocked by required conditions
Test / End-to-End Tests Success (push) Blocked by required conditions
Test / Unit Test Mobile (push) Blocked by required conditions
Test / .github Files Formatting (push) Blocked by required conditions
Test / ShellCheck (push) Waiting to run
Test / OpenAPI Clients (push) Waiting to run
Test / SQL Schema Checks (push) Waiting to run
CLI Build / CLI Publish (push) Has been cancelled
CLI Build / Docker (push) Has been cancelled
|
||
|---|---|---|
| .. | ||
| bin | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .npmignore | ||
| .prettierignore | ||
| .prettierrc | ||
| Dockerfile | ||
| eslint.config.mjs | ||
| LICENSE | ||
| mise.toml | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| vite.config.ts | ||
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. You can use the following command:
$ mise //:open-api
Run from build
Go to the cli folder and build it:
$ pnpm install
$ pnpm run build
$ node dist/index.js
Run and Debug from source (VSCode)
With VScode you can run and debug the Immich CLI. Go to the launch.json file, find the Immich CLI config and change this with the command you need to debug
"args": ["upload", "--help"],
replace that for the command of your choice.
Install from build
You can also build and install the CLI using
$ pnpm run build
$ pnpm install -g .