mirror of
https://github.com/immich-app/immich.git
synced 2025-10-31 10:37:11 -04:00
6f4449d5e9
* Add new cli * Remove old readme * Add documentation to readme file * Add github workflow tests for cli * Fix typo in docs * Add usage info to readme * Add package-lock.json * Fix tsconfig * Cleanup * Fix lint * Cleanup package.json * Fix accidental server change * Remove rootdir from cli * Remove tsbuildinfo * Add prettierignore * Make CLI use internal openapi specs * Add ignore and dry-run features * Sort paths alphabetically * Don't remove substring * Remove shorthand for delete * Remove unused import * Remove chokidar * Set correct openapi cli generator script * Add progress bar * Rename target to asset * Add deletion progress bar * Ignore require statement * Use read streams instead of readfile * Fix github feedback * Fix upload requires * More github comments * Cleanup messages * Cleaner pattern concats * Github comments --------- Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
47 lines
1.1 KiB
Markdown
47 lines
1.1 KiB
Markdown
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
|