immich/cli
2024-02-12 16:17:28 -05:00
..
src chore: remove unneccessary async/awaits (#7009) 2024-02-10 00:12:51 +00:00
test chore: tree shake unused API methods from CLI (#6973) 2024-02-09 15:53:37 -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.cjs chore(server,cli,web): housekeeping and stricter code style (#6751) 2024-02-01 22:18:00 -05: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 feat(cli): dockerize (#6858) 2024-02-06 12:17:15 +01:00
LICENSE Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +00:00
package-lock.json chore: update lockfiles (#7062) 2024-02-12 16:17:28 -05:00
package.json Change license to AGPLv3 (#7046) 2024-02-12 15:31:59 +00: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.json chore(server,cli,web): housekeeping and stricter code style (#6751) 2024-02-01 22:18:00 -05:00
vite.config.ts fix: bundle CLI with Vite (#6893) 2024-02-03 21:39:01 -06: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 .