History

Feng Kaiyu 4cb165304b fix(cli): handle patterns correctly on Windows (#10430 ) Modify the handling of patterns in the `crawl` function to correctly convert the current path to a pattern when it contains backslash on Windows, in according to fast-glob's docs.		2024-06-21 17:09:02 +07:00
..
src	fix(cli): handle patterns correctly on Windows (#10430 )	2024-06-21 17:09:02 +07:00
.editorconfig	…
.eslintignore	…
.eslintrc.cjs	chore(deps): update dependency eslint-plugin-unicorn to v52 (#8629 )	2024-04-08 12:45:46 +07:00
.gitignore	test(cli): e2e testing (#5101 )	2023-12-18 20:29:26 +07:00
.npmignore	chore(cli): clean up files (#7955 )	2024-03-14 13:09:27 +07:00
.nvmrc	fix(deps): update typescript-projects (#9971 )	2024-06-04 10:35:24 +07:00
.prettierignore	refactor: open api (#6334 )	2024-01-12 07:36:27 +07:00
.prettierrc	chore(cli): auto-sort imports (#7116 )	2024-02-14 09:55:40 +07:00
Dockerfile	chore(deps): update node.js to eb17a08 (#10098 )	2024-06-14 02:34:08 +07:00
LICENSE	Change license to AGPLv3 (#7046 )	2024-02-12 15:31:59 +07:00
README.md	…
package-lock.json	chore(deps): update dependency eslint-plugin-unicorn to v54 (#10486 )	2024-06-19 12:56:35 +07:00
package.json	chore(deps): update dependency eslint-plugin-unicorn to v54 (#10486 )	2024-06-19 12:56:35 +07:00
tsconfig.json	chore(cli): clean up files (#7955 )	2024-03-14 13:09:27 +07: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 +07:00

README.md

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 .