immich/cli
renovate[bot] 4f02412493
Some checks failed
CodeQL / Analyze (javascript) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
Docker / Build and Push (., cpu, server/Dockerfile, immich-server, linux/amd64,linux/arm64) (push) Waiting to run
Docker / Build and Push (machine-learning, armnn, machine-learning/Dockerfile, immich-machine-learning, linux/arm64, -armnn) (push) Waiting to run
Docker / Build and Push (machine-learning, cpu, machine-learning/Dockerfile, immich-machine-learning, linux/amd64,linux/arm64) (push) Waiting to run
Docker / Build and Push (machine-learning, cuda, machine-learning/Dockerfile, immich-machine-learning, linux/amd64, -cuda) (push) Waiting to run
Docker / Build and Push (machine-learning, openvino, machine-learning/Dockerfile, immich-machine-learning, linux/amd64, -openvino) (push) Waiting to run
Docs build / build (push) Waiting to run
Static Code Analysis / Run Dart Code Analysis (push) Waiting to run
Test / Server (push) Waiting to run
Test / CLI (push) Waiting to run
Test / CLI (Windows) (push) Waiting to run
Test / Web (push) Waiting to run
Test / End-to-End Tests (push) Waiting to run
Test / Mobile (push) Waiting to run
Test / Machine Learning (push) Waiting to run
Test / ShellCheck (push) Waiting to run
Test / OpenAPI Clients (push) Waiting to run
Test / TypeORM Checks (push) Waiting to run
CLI Build / Publish (push) Has been cancelled
CLI Build / Docker (push) Has been cancelled
chore(deps): update dependency node to v20.17.0 (#12040)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-08-25 22:50:51 -04:00
..
src feat(cli): use a queue for duplicate and upload (#10750) 2024-07-08 22:39:07 -05: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 dependency node to v20.17.0 (#12040) 2024-08-25 22:50:51 -04: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: dockerfile casing (#11588) 2024-08-05 12:07:28 +00:00
eslint.config.mjs chore(deps): update dependency eslint to v9 (#11601) 2024-08-05 16:13:16 -04:00
LICENSE Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +00:00
package-lock.json chore(deps): update dependency @types/node to ^20.14.15 (#11920) 2024-08-20 00:30:28 -04:00
package.json chore(deps): update dependency node to v20.17.0 (#12040) 2024-08-25 22:50:51 -04:00
README.md docs: remove old CLI first (#5163) 2023-11-19 16:41:42 -06: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

To run the Immich CLI from source, run the following in the cli folder:

$ 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 .