immich/packages/cli
bo0tzz 4a68a87531
fix: use trixie-slim base image for cli and e2e-auth-server (#30411)
The alpine suffix part wasn't getting updated by renovate, and the 3.20
chain stopped getting node updates too. This also just aligns the base
image distro with what we use elsewere.
2026-07-30 15:14:18 -04:00
..
bin refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
src chore(cli): remove -h shorthand for --skip-hash (#30119) 2026-07-22 13:25:29 +02: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 fix: use trixie-slim base image for cli and e2e-auth-server (#30411) 2026-07-30 15:14:18 -04:00
eslint.config.mjs chore(deps): update dependency eslint-plugin-unicorn to v72 (#30092) 2026-07-21 15:33:46 +02:00
LICENSE refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00
mise.toml chore: sequence pnpm installs in mise tasks (#30412) 2026-07-30 15:12:42 -04:00
package.json chore: version v3.1.0 2026-07-27 18:20:33 +00:00
README.md chore: mise scripts (#28367) 2026-05-11 17:46:02 -04:00
tsconfig.json chore(deps): update dependency eslint-plugin-unicorn to v70 - abandoned (#29684) 2026-07-20 23:47:14 -04:00
vite.config.ts refactor: move cli to package folder (#28356) 2026-05-11 14:49:45 -04:00

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 .