Skip to content

chore: update cli docs to pnpm #22702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mertalev merged 1 commit into from
Oct 6, 2025
Merged

chore: update cli docs to pnpm #22702

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ Please see the [Immich CLI documentation](https://immich.app/docs/features/comma

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
$ pnpm install
$ pnpm 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
$ pnpm install
$ pnpm run build
$ ts-node .

You'll need ts-node, the easiest way to install it is to use npm:
You'll need ts-node, the easiest way to install it is to use pnpm:

$ npm i -g ts-node
$ pnpm i -g ts-node

You can also build and install the CLI using

$ npm run build
$ npm install -g .
$ pnpm run build
$ pnpm install -g .
****
Loading