From c85563da50e19c249d1e98d8b804c1b2d7ed6ad7 Mon Sep 17 00:00:00 2001 From: Timothy Pillow Date: Sat, 23 Mar 2024 21:24:53 +0100 Subject: [PATCH] Update command-line-interface.md (#8213) * Update command-line-interface.md Update documentation for CLI commands. * chore: update docs * chore: login-key => login --------- Co-authored-by: Jason Rasmussen --- docs/docs/features/command-line-interface.md | 42 +++++++++++--------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/docs/features/command-line-interface.md b/docs/docs/features/command-line-interface.md index bb34f8a0f6..094de609ff 100644 --- a/docs/docs/features/command-line-interface.md +++ b/docs/docs/features/command-line-interface.md @@ -54,16 +54,19 @@ Usage: immich [options] [command] Command line interface for Immich Options: - -V, --version output the version number - -d, --config Configuration directory (env: IMMICH_CONFIG_DIR) - -h, --help display help for command + -V, --version output the version number + -d, --config-directory Configuration directory where auth.yml will be stored (default: "~/.config/immich/", env: + IMMICH_CONFIG_DIR) + -u, --url [url] Immich server URL (env: IMMICH_INSTANCE_URL) + -k, --key [key] Immich API key (env: IMMICH_API_KEY) + -h, --help display help for command Commands: - upload [options] [paths...] Upload assets - server-info Display server information - login [url] [key] Login using an API key - logout Remove stored credentials - help [command] display help for command + login|login-key Login using an API key + logout Remove stored credentials + server-info Display server information + upload [options] [paths...] Upload assets + help [command] display help for command ``` ## Commands @@ -71,23 +74,24 @@ Commands: The upload command supports the following options: ``` -Usage: immich upload [options] [paths...] +Usage: immich upload [paths...] [options] Upload assets Arguments: - paths One or more paths to assets to be uploaded + paths One or more paths to assets to be uploaded Options: - -r, --recursive Recursive (default: false, env: IMMICH_RECURSIVE) - -i, --ignore [paths...] Paths to ignore (env: IMMICH_IGNORE_PATHS) - -h, --skip-hash Don't hash files before upload (default: false, env: IMMICH_SKIP_HASH) - -H, --include-hidden Include hidden folders (default: false, env: IMMICH_INCLUDE_HIDDEN) - -a, --album Automatically create albums based on folder name (default: false, env: IMMICH_AUTO_CREATE_ALBUM) - -A, --album-name Add all assets to specified album (env: IMMICH_ALBUM_NAME) - -n, --dry-run Don't perform any actions, just show what will be done (default: false, env: IMMICH_DRY_RUN) - --delete Delete local assets after upload (env: IMMICH_DELETE_ASSETS) - --help display help for command + -r, --recursive Recursive (default: false, env: IMMICH_RECURSIVE) + -i, --ignore [paths...] Paths to ignore (default: [], env: IMMICH_IGNORE_PATHS) + -h, --skip-hash Don't hash files before upload (default: false, env: IMMICH_SKIP_HASH) + -H, --include-hidden Include hidden folders (default: false, env: IMMICH_INCLUDE_HIDDEN) + -a, --album Automatically create albums based on folder name (default: false, env: IMMICH_AUTO_CREATE_ALBUM) + -A, --album-name Add all assets to specified album (env: IMMICH_ALBUM_NAME) + -n, --dry-run Don't perform any actions, just show what will be done (default: false, env: IMMICH_DRY_RUN) + -c, --concurrency Number of assets to upload at the same time (default: 4, env: IMMICH_UPLOAD_CONCURRENCY) + --delete Delete local assets after upload (env: IMMICH_DELETE_ASSETS) + --help display help for command ``` Note that the above options can read from environment variables as well.