From c1239a7337b0f88c49f7bab231ca3ddbf339d3c7 Mon Sep 17 00:00:00 2001 From: Jonathan Jogenfors Date: Sun, 19 Nov 2023 23:41:42 +0100 Subject: [PATCH] docs: remove old CLI first (#5163) --- cli/README.md | 47 +---------------------------------------------- 1 file changed, 1 insertion(+), 46 deletions(-) diff --git a/cli/README.md b/cli/README.md index 78706d0f5..a570a5523 100644 --- a/cli/README.md +++ b/cli/README.md @@ -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