History

Jason Rasmussen d2807b8d6a feat(web,server): offline/untracked files admin tool (#4447 ) * feat: admin repair orphans tool * chore: open api * fix: include upload folder * fix: bugs * feat: empty placeholder * fix: checks * feat: move buttons to top of page * feat: styling and clipboard * styling * better clicking hitbox * fix: show title on hover * feat: download report * restrict file access to immich related files * Add description --------- Co-authored-by: Alex Tran <alex.tran1502@gmail.com> Co-authored-by: Daniel Dietzler <mail@ddietzler.dev>		2023-10-14 19:12:59 +02:00
..
src	feat(web,server): offline/untracked files admin tool (#4447 )	2023-10-14 19:12:59 +02: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	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	chore(server,web,docs) bulk bump of dependencies with vulnerabilities (#4312 )	2023-10-10 08:31:21 -04: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