immich/docs/docs/features
Bence Ferdinandy 31af44dd2a
feat: add --json-output option to upload command (#18845)
* fix(docs): update the cli upload usage

The cli upload usage is missing some options compared to what is the current
output of `immich upload --help`. Update the docs accordingly.

Signed-off-by: Bence Ferdinandy <bence@ferdinandy.com>

* feat(cli): add --json-output option to upload command

Add an option that allows retrieving per-file information about the
upload process. The output includes the newFiles, duplicates and
newAssets lists, but could accommodate more information later if needed.

One use case this allows for is using --dry-run to get a list of all the
files that would be uploaded, and checking them manually before an
upload. This can be particularly useful when a curated subset of images
have already been uploaded to immich and we want to double check for
some stragglers without uploading everything to immich.

The upload command has a few lines of logging, so to get an actually
parsable json one needs to strip those lines:

  immich upload --dry-run * | tail -n +4 | jq .newFiles[]

Signed-off-by: Bence Ferdinandy <bence@ferdinandy.com>

---------

Signed-off-by: Bence Ferdinandy <bence@ferdinandy.com>
2025-06-02 01:58:58 +00:00
..
img feat(web): make google cast opt in (#18514) 2025-05-28 15:57:36 -05:00
_category_.json chore(docs): refactor pages (#1144) 2022-12-21 15:01:50 -06:00
automatic-backup.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00
casting.md feat(web): make google cast opt in (#18514) 2025-05-28 15:57:36 -05:00
command-line-interface.md feat: add --json-output option to upload command (#18845) 2025-06-02 01:58:58 +00:00
facial-recognition.md docs: better facial recognition cluster guide (#14911) 2025-03-03 18:33:32 +00:00
folder-view.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00
hardware-transcoding.md fix(docs): Update old jellyfin docs links (#18311) 2025-05-15 15:32:31 +00:00
libraries.md fix: various typos (grouped in to separate commits) (#18177) 2025-05-09 13:10:34 +00:00
ml-hardware-acceleration.md feat(docs): documentation update (#17720) 2025-04-20 23:55:58 -05:00
mobile-app.mdx fix(docs): fix admonition in mobile section (#15291) 2025-01-12 21:12:26 -06:00
monitoring.md fix: broken link on monitoring page (#15478) 2025-01-20 22:20:03 -06:00
partner-sharing.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00
reverse-geocoding.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00
searching.md feat: vectorchord (#18042) 2025-05-20 08:36:43 -05:00
sharing.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00
supported-formats.md docs: fix png extension typo in supported formats table (#16636) 2025-03-06 11:44:06 +00:00
tags.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00
user-settings.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00
xmp-sidecars.md chore(docs): clean up and add new content (#15003) 2025-01-02 10:04:14 -06:00