Merge branch 'main' of https://github.com/immich-app/immich into feat/cli-e2e

This commit is contained in:
Jonathan Jogenfors 2023-11-19 23:56:49 +01:00
commit 0388a8a79b
2 changed files with 4 additions and 49 deletions

View file

@ -1,51 +1,6 @@
A command-line interface for interfacing with the self-hosted photo manager [Immich](https://immich.app/).
# Installing
To use the cli, run
$ npm install @immich/cli
# Usage
To use the CLI, you need to login with an API key first:
$ immich login-key https://your-immich-instance/api your-api-key
NOTE: This will store your api key in cleartext under ~/.config/immich/auth.yml
Next, you can run commands, for example:
$ immich server-info
When you're done, log out to remove the credentials from your filesystem
$ immich logout
# Commands
```
Usage: immich [options] [command]
Immich command line interface
Options:
-h, --help display help for command
Commands:
upload [options] [paths...] Upload assets
server-info Display server information
login-key [instanceUrl] [apiKey] Login using an API key
logout Remove stored credentials
help [command] display help for command
```
# Todo
- Sidecar should check both .jpg.xmp and .xmp
- Sidecar check could be case-insensitive
- Use the SDK for all api calls. We currently use raw axos http calls
- Use list of supported files from server via api
Please see the [Immich CLI documentation](https://immich.app/docs/features/command-line-interface).
# For developers

6
cli/package-lock.json generated
View file

@ -54,7 +54,7 @@
},
"../server": {
"name": "immich",
"version": "1.86.0",
"version": "1.87.0",
"dev": true,
"license": "UNLICENSED",
"dependencies": {
@ -113,7 +113,7 @@
"@nestjs/testing": "^10.2.2",
"@openapitools/openapi-generator-cli": "2.7.0",
"@testcontainers/postgresql": "^10.2.1",
"@types/archiver": "^5.3.2",
"@types/archiver": "^6.0.0",
"@types/bcrypt": "^5.0.0",
"@types/cookie-parser": "^1.4.3",
"@types/cron": "^2.0.1",
@ -10458,7 +10458,7 @@
"@openapitools/openapi-generator-cli": "2.7.0",
"@socket.io/redis-adapter": "^8.2.1",
"@testcontainers/postgresql": "^10.2.1",
"@types/archiver": "^5.3.2",
"@types/archiver": "^6.0.0",
"@types/bcrypt": "^5.0.0",
"@types/cookie-parser": "^1.4.3",
"@types/cron": "^2.0.1",