History

Mert bcc36d14a1 feat(ml)!: customizable ML settings (#3891 ) * consolidated endpoints, added live configuration * added ml settings to server * added settings dashboard * updated deps, fixed typos * simplified modelconfig updated tests * Added ml setting accordion for admin page updated tests * merge `clipText` and `clipVision` * added face distance setting clarified setting * add clip mode in request, dropdown for face models * polished ml settings updated descriptions * update clip field on error * removed unused import * add description for image classification threshold * pin safetensors for arm wheel updated poetry lock * moved dto * set model type only in ml repository * revert form-data package install use fetch instead of axios * added slotted description with link updated facial recognition description clarified effect of disabling tasks * validation before model load * removed unnecessary getconfig call * added migration * updated api updated api updated api --------- Co-authored-by: Alex Tran <alex.tran1502@gmail.com>		2023-08-29 08:58:00 -05:00
..
src	feat(ml)!: customizable ML settings (#3891 )	2023-08-29 08:58:00 -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	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
.gitignore	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
.prettierignore	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
.prettierrc	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
package-lock.json	fix(cli): move runtime dependencies to correct section (#3371 )	2023-07-21 23:01:20 -05:00
package.json	fix(cli): move runtime dependencies to correct section (#3371 )	2023-07-21 23:01:20 -05:00
README.md	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05: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	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00

README.md

A command-line interface for interfacing with Immich

Getting started

$ ts-node cli/src

To start using the CLI, you need to login with an API key first:

$ ts-node cli/src login-key https://your-immich-instance/api your-api-key

NOTE: This will store your api key under ~/.config/immich/auth.yml

Next, you can run commands:

$ ts-node cli/src server-info

When you're done, log out to remove the credentials from your filesystem

$ ts-node cli/src logout

Usage

Usage: immich [options] [command]

Immich command line interface

Options:
  -h, --help                        display help for command

Commands:
  upload [options] [paths...]       Upload assets
  import [options] [paths...]       Import existing assets
  server-info                       Display server information
  login-key [instanceUrl] [apiKey]  Login using an API key
  help [command]                    display help for command

Todo

Sidecar should check both .jpg.xmp and .xmp
Sidecar check could be case-insensitive

Known issues

Upload can't use sdk due to multiple issues