immich/cli
Mert d52ed51aab
fix(cli): dry run being inaccurate (#9088)
2024-04-25 21:14:48 +07:00
..
src fix(cli): dry run being inaccurate (#9088) 2024-04-25 21:14:48 +07:00
.editorconfig feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 +07:00
.eslintignore feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 +07:00
.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
.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 ec0c413 (#8833) 2024-04-17 07:53:00 +07:00
LICENSE Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +07:00
README.md docs: remove old CLI first (#5163) 2023-11-19 16:41:42 +07:00
package-lock.json fix(cli): `--ignore` getting ignored (#9071) 2024-04-25 10:48:17 +07:00
package.json fix(cli): `--ignore` getting ignored (#9071) 2024-04-25 10:48:17 +07:00
tsconfig.json chore(cli): clean up files (#7955) 2024-03-14 13:09:27 +07:00
vite.config.ts refactor(cli): simplify (#7962) 2024-03-14 19:09:28 +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 .