mirror-immich/packages/cli
moversity afa836181c
fix(cli): prevent out-of-memory on file upload due to undici storing the request body (#28723)
fix(cli): add fetch param to prevent OOM of upload

Issue due to undici storing the entire request body in memory.
Related undici bug report: https://github.com/nodejs/undici/issues/4058

Fixes https://github.com/immich-app/immich/issues/28720

Signed-off-by: moversity <148445403+moversity@users.noreply.github.com>
2026-06-03 15:19:35 +00:00
..
bin refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
src fix(cli): prevent out-of-memory on file upload due to undici storing the request body (#28723) 2026-06-03 15:19:35 +00:00
.editorconfig refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
.gitignore refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
.npmignore refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
.prettierignore refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
.prettierrc refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
Dockerfile refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
LICENSE refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
README.md chore: mise scripts (#28367) 2026-05-11 17:46:02 -04:00
eslint.config.mjs refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
mise.toml refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
package.json chore(deps): update dependency @types/node to ^24.12.4 (#28490) 2026-05-20 12:41:17 +02:00
tsconfig.json refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
vite.config.ts refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00

README.md

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 .