immich/cli
2024-06-11 12:16:49 +00:00
..
src refactor: asset media endpoints (#9831) 2024-05-31 13:44:04 -04:00
.editorconfig feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 -05:00
.eslintignore feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 -05:00
.eslintrc.cjs chore(deps): update dependency eslint-plugin-unicorn to v52 (#8629) 2024-04-08 12:45:46 -04: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 fix(deps): update typescript-projects (#9971) 2024-06-04 10:35:24 +01: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(deps): update node.js to 696ae41 (#9986) 2024-06-04 20:21:28 -04:00
LICENSE Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +00:00
package-lock.json chore(cli): prepare release (#10124) 2024-06-11 12:16:49 +00:00
package.json chore(cli): prepare release (#10124) 2024-06-11 12:16:49 +00: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 refactor(cli): simplify (#7962) 2024-03-14 19:09:28 -04: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 .