mirror of
https://github.com/immich-app/immich.git
synced 2026-01-07 02:23:54 -08:00
7e38e7c949
* Allow building and installing cli * feat: add format fix * docs: remove cli folder * feat: use immich scoped package * feat: rewrite cli readme * docs: add info on running without building * cleanup * chore: remove import functionality from cli * feat: add logout to cli * docs: add todo for file format from server * docs: add compilation step to cli * fix: success message spacing * feat: can create albums * fix: add check step to cli * fix: typos * feat: pull file formats from server * chore: use crawl service from server * chore: fix lint * docs: add cli documentation * chore: rename ignore pattern * chore: add version number to cli * feat: use sdk * fix: cleanup * feat: album name on windows * chore: remove skipped asset field * feat: add more info to server-info command * chore: cleanup * chore: remove unneeded packages * chore: fix docs links * feat: add cli v2 milestone * fix: set correct cli date --------- Co-authored-by: Alex <alex.tran1502@gmail.com>
65 lines
1.5 KiB
Markdown
65 lines
1.5 KiB
Markdown
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
|
|
|
|
# For developers
|
|
|
|
To run the Immich CLI from source, run the following in the cli folder:
|
|
|
|
$ npm run build
|
|
$ ts-node .
|
|
|
|
You'll need ts-node, the easiest way to install it is to use npm:
|
|
|
|
$ npm i -g ts-node
|
|
|
|
You can also build and install the CLI using
|
|
|
|
$ npm run build
|
|
$ npm install -g .
|