immich/cli
Jason Rasmussen 69166fa520
chore(cli): auto-sort imports (#7116)
2024-02-14 09:55:40 +07:00
..
src chore(cli): auto-sort imports (#7116) 2024-02-14 09:55:40 +07:00
test chore(cli): auto-sort imports (#7116) 2024-02-14 09:55:40 +07:00
.editorconfig
.eslintignore
.eslintrc.cjs chore(server,cli,web): housekeeping and stricter code style (#6751) 2024-02-01 22:18:00 +07:00
.gitignore test(cli): e2e testing (#5101) 2023-12-18 20:29:26 +07:00
.npmignore test(cli): e2e testing (#5101) 2023-12-18 20:29:26 +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 feat(cli): dockerize (#6858) 2024-02-06 12:17:15 +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 chore(cli): auto-sort imports (#7116) 2024-02-14 09:55:40 +07:00
package.json chore(cli): auto-sort imports (#7116) 2024-02-14 09:55:40 +07:00
testSetup.js
tsconfig.json chore(server,cli,web): housekeeping and stricter code style (#6751) 2024-02-01 22:18:00 +07:00
vite.config.ts fix: bundle CLI with Vite (#6893) 2024-02-03 21:39:01 +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 .