c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-29 15:11:58 +00:00
Code Releases Activity

docs: remove old CLI first (#5163)

Browse source
This commit is contained in:
Jonathan Jogenfors 2023-11-19 23:41:42 +01:00 committed by GitHub
parent 7e38e7c949
commit c1239a7337
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
cli/README.md
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