immich/cli
Min Idzelis 845b0f2073
chore: use pnpm for builds (#19752)
* Migrate from npm to pnpm across entire project

• Update all GitHub workflow files to use pnpm instead of npm
• Replace npm commands with pnpm equivalents in devcontainer scripts
• Remove package-lock.json files and update to use pnpm-lock.yaml
• Consolidate node version references to use server/.nvmrc

* Refine pnpm migration based on review feedback

• Replace SKIP_SHARP_FILTERING with SHARP_IGNORE_GLOBAL_LIBVIPS environment variable
• Improve Sharp package filtering to include specific Linux architectures for Docker builds
• Optimize Dockerfile dependency caching with improved layer structure
• Clean up workspace configuration and remove redundant settings

* Address additional review feedback for pnpm migration

• Fix node-version-file paths in GitHub workflow configurations
• Refactor .pnpmfile.cjs to use switch statement for better code organization
• Correct cache type typo in fix-format workflow
• Simplify Vite configuration by merging configs inline
• Update package description for consistency

* Use 'server/.nvmrc' for fix-format.yml GHA

* Delete npm locks

* Remove Docker volume isolation for node_modules directories

• Remove volume mounts for node_modules and related directories
• Allow shared access between host and container filesystem
• Update init container to handle file ownership with conditional existence check

* Remove unused Docker volumes and volume mounts

• Remove node_modules volume mounts from devcontainer configuration
• Remove unused named volumes for pnpm-store, node_modules, and cache directories
• Clean up Docker Compose configuration after removing volume isolation

* Fix typescript-sdk package issues

• Remove unknown "build" dependency that was incorrectly added to package.json
• Update pnpm-lock.yaml to reflect dependency removal

* Add pnpm setup to mobile workflow for translation formatting

• Add pnpm action setup step to mobile unit tests workflow
• Required for translation file formatting and sorting operations

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>
2025-08-19 08:55:24 -04:00
..
bin feat: bin for cli (#19648) 2025-07-01 08:00:41 -04:00
src fix: cli upload deletes files that failed uploading (#19140) 2025-06-12 17:32:35 -04:00
.editorconfig feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 -05:00
.gitignore test(cli): e2e testing (#5101) 2023-12-18 20:29:26 -06:00
.npmignore chore(cli): clean up files (#7955) 2024-03-14 13:09:27 -04:00
.nvmrc chore(deps): update node.js to v22.18.0 (#20662) 2025-08-05 11:01:15 +00:00
.prettierignore refactor: open api (#6334) 2024-01-12 07:36:27 -05:00
.prettierrc chore(cli): auto-sort imports (#7116) 2024-02-14 09:55:40 -05:00
Dockerfile chore: use pnpm for builds (#19752) 2025-08-19 08:55:24 -04:00
eslint.config.mjs chore: finish migrating eslint config files; bump unicorn (#17200) 2025-03-31 12:18:25 +01:00
LICENSE Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +00:00
package.json chore(deps): update dependency @types/node to ^22.17.1 (#21047) 2025-08-19 13:13:49 +02:00
README.md fix(cli): Update build instructions for CLI (#11874) 2024-08-28 13:25:58 +00:00
tsconfig.json chore(cli): clean up files (#7955) 2024-03-14 13:09:27 -04:00
vite.config.ts fix(cli): handle patterns correctly on Windows (#10430) 2024-06-21 17:09:02 -07:00
vitest.config.ts chore: migrate CLI to ESM and vitest (#6777) 2024-01-30 18:23:33 -05: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. 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 .