1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-01 09:51:16 +02:00
immich/cli
Alex c254a04aec
feat(server): add endpoint to get supported media types on the server (#3284)
* feat(server): add endpoint to get supported media types on the server

* api generation

* remove xmp format

* change dto

* openapi

* dev
2023-07-15 20:24:46 -05:00
..
src feat(server): add endpoint to get supported media types on the server (#3284) 2023-07-15 20:24:46 -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

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