History

Jonathan Jogenfors 6f4449d5e9 feat(cli) Add new CLI (#3066 ) * Add new cli * Remove old readme * Add documentation to readme file * Add github workflow tests for cli * Fix typo in docs * Add usage info to readme * Add package-lock.json * Fix tsconfig * Cleanup * Fix lint * Cleanup package.json * Fix accidental server change * Remove rootdir from cli * Remove tsbuildinfo * Add prettierignore * Make CLI use internal openapi specs * Add ignore and dry-run features * Sort paths alphabetically * Don't remove substring * Remove shorthand for delete * Remove unused import * Remove chokidar * Set correct openapi cli generator script * Add progress bar * Rename target to asset * Add deletion progress bar * Ignore require statement * Use read streams instead of readfile * Fix github feedback * Fix upload requires * More github comments * Cleanup messages * Cleaner pattern concats * Github comments --------- Co-authored-by: Alex Tran <alex.tran1502@gmail.com>		2023-07-06 09:37:47 -05:00
..
src	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
test	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -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
asdf	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
jest.config.ts	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
package-lock.json	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -05:00
package.json	feat(cli) Add new CLI (#3066 )	2023-07-06 09:37:47 -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.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