mirror of
https://github.com/immich-app/immich.git
synced 2025-10-31 02:27:08 -04:00
7ee1b977c1
* add debug and change ts-node with tsx * update pr changes * update pnpm-lock * remove ts-node from readme * typo * resolve conflicts * remove tsx * launch from dist * add preLaunchTask * update readme * undo main in package.json * remove typo * Apply suggestion from @bwees Co-authored-by: Brandon Wees <brandonwees@gmail.com> * revert pnpm-lock changes * @jrasm91 suggestions * chore: run node with source maps --------- Co-authored-by: Jason Rasmussen <jason@rasm.me> Co-authored-by: Brandon Wees <brandonwees@gmail.com>
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:
$ 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
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 .