immich-app/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-12-17 17:23:20 +03:00
Code Issues Packages Projects Releases 16 Wiki Activity

chore(cli): rename commands (#8200)

Browse Source 
* chore(cli): rename login command

* chore: rename key/url
This commit is contained in:
Jason Rasmussen
2024-03-22 15:09:04 -04:00
committed by GitHub
parent 5b7417bf64
commit 75aa8e6621
6 changed files with 37 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/features/command-line-interface.md
View File

@@ -61,7 +61,7 @@ Options:
Commands:
upload [options] [paths...] Upload assets
server-info Display server information
login-key [instanceUrl] [apiKey] Login using an API key
login [url] [key] Login using an API key
logout Remove stored credentials
help [command] display help for command
```
@@ -97,13 +97,13 @@ Note that the above options can read from environment variables as well.
You begin by authenticating to your Immich server.
```bash
immich login-key [instanceUrl] [apiKey]
immich login [url] [key]
```
For instance,
```bash
immich login-key http://192.168.1.216:2283/api HFEJ38DNSDUEG
immich login http://192.168.1.216:2283/api HFEJ38DNSDUEG
```
This will store your credentials in a `auth.yml` file in the configuration directory which defaults to `~/.config/`. The directory can be set with the `-d` option or the environment variable `IMMICH_CONFIG_DIR`. Please keep the file secure, either by performing the logout command after you are done, or deleting it manually.