immich/cli
2024-01-30 07:55:34 -05:00
..
src refactor(cli): organize files, simplify types, use @immich/sdk (#6747) 2024-01-30 07:55:34 -05:00
test refactor(cli): organize files, simplify types, use @immich/sdk (#6747) 2024-01-30 07:55:34 -05: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.js fix(server,cli): don't float promises (#4433) 2023-10-13 01:22:40 -04:00
.gitignore test(cli): e2e testing (#5101) 2023-12-18 20:29:26 -06:00
.npmignore test(cli): e2e testing (#5101) 2023-12-18 20:29:26 -06:00
.prettierignore refactor: open api (#6334) 2024-01-12 07:36:27 -05:00
.prettierrc feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 -05:00
Dockerfile chore(deps): update base-image to v20240125 (major) (#6637) 2024-01-25 20:59:47 -06:00
LICENSE chore(cli): push to npm (#5168) 2023-11-20 14:04:20 +01:00
package-lock.json refactor(cli): organize files, simplify types, use @immich/sdk (#6747) 2024-01-30 07:55:34 -05:00
package.json refactor(cli): organize files, simplify types, use @immich/sdk (#6747) 2024-01-30 07:55:34 -05:00
README.md docs: remove old CLI first (#5163) 2023-11-19 16:41:42 -06:00
testSetup.js feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 -05:00
tsconfig.build.json feat(cli): add build script and unify tests (#3369) 2023-07-21 13:10:01 -05:00
tsconfig.json refactor(cli): organize files, simplify types, use @immich/sdk (#6747) 2024-01-30 07:55:34 -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 .