immich/cli
Alex af1113bf9e
chore(cli): add version option (#5237)
* chore(cli): add version option

* chore: update build path

* fix: defer to package details for path to entrypoint

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2023-11-21 13:12:40 +07:00
..
src chore(cli): add version option (#5237) 2023-11-21 13:12:40 +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.js fix(server,cli): don't float promises (#4433) 2023-10-13 01:22:40 +07:00
.gitignore feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 +07:00
.npmignore chore(cli): push to npm (#5168) 2023-11-20 14:04:20 +07:00
.prettierignore feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 +07:00
.prettierrc feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 +07:00
LICENSE chore(cli): push to npm (#5168) 2023-11-20 14:04:20 +07:00
README.md docs: remove old CLI first (#5163) 2023-11-19 16:41:42 +07:00
package-lock.json chore(cli): add version option (#5237) 2023-11-21 13:12:40 +07:00
package.json chore(cli): add version option (#5237) 2023-11-21 13:12:40 +07:00
testSetup.js feat(cli) Add new CLI (#3066) 2023-07-06 09:37:47 +07:00
tsconfig.build.json feat(cli): add build script and unify tests (#3369) 2023-07-21 13:10:01 +07:00
tsconfig.json feat(cli): refactor and add album support (#4434) 2023-11-19 22:16:24 +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 .