self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-25 10:43:13 +02:00
Code Issues Releases Activity
54b9bfaeef
immich/cli
History
Jason Rasmussen 753dab8b3c
feat(server): asset search endpoint (#4931) 
* feat(server): GET /assets endpoint

* chore: open api

* chore: use dumb name

* feat: search by make, model, lens, city, state, country

* chore: open api

* chore: pagination validation and tests

* chore: pr feedback
2023-11-14 22:47:15 +00:00
..
src feat(server): asset search endpoint (#4931) 2023-11-14 22:47:15 +00: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(deps): update dependency eslint to v8.53.0 (#4986) 2023-11-12 21:46:22 -06: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