install

Additional install commands

macOS

Homebrewverified · 100%

brew install immich-cli

local Homebrew formula metadata

Linux

Nixverified · 92%

nix profile install nixpkgs#immich-cli

nixpkgs package indexes · pkgs/by-name/im/immich-cli/package.nix · source: api.github.com

overview

Package summary

Command-line interface for self-hosted photo manager Immich

Project links

Commands and aliases

immich

history

Project history and usage

immich-cli is the official command-line interface for Immich, the self-hosted photo and video management project. It is distributed from the Immich monorepo as the @immich/cli npm package and as an immich-cli container image.

Project history

Immich's GitHub repository was created on 2022-02-03 and grew into a high-profile self-hosted alternative to cloud photo libraries. The CLI became the official automation surface for uploading photos and videos, checking server information, and authenticating with API keys outside the web and mobile clients.

The @immich/cli package metadata records publication history beginning in 2023. Official documentation describes the migration from a legacy npm package named immich to the scoped @immich/cli package, plus a Docker invocation path for users who do not want to install Node.js locally.

Adoption history

immich-cli adoption follows Immich adoption. Repository metadata shows Immich with a very large GitHub audience, and Homebrew formula analytics show the CLI receiving thousands of installs over the measured 365-day formula window. The input metadata also records Nix packaging.

The CLI occupies a pragmatic role in the Immich ecosystem: it is the supported tool for bulk upload and scripting, while the official docs point users with Google Photos Takeout needs to the community-maintained immich-go tool.

How it is used

The official docs document login with an Immich server URL and API key, storage of credentials in auth.yml under ~/.config/immich by default, upload of files and directories, recursive upload, dry runs, album creation, duplicate handling, ignore globs, concurrency, JSON output, and environment-variable configuration.

Why package nerds care

immich-cli is package-nerd significant because it is a companion CLI for a fast-moving self-hosted application, and its packaging spans npm, Docker, Homebrew, and Nix. It also demonstrates the common tradeoff that led to immich-go: official Node-based CLIs are easy for project maintainers to ship from a TypeScript monorepo, while some users prefer static single-binary migration tools.

Timeline

2022-02-03: Immich GitHub repository created.
2023-11-19: @immich/cli npm package metadata records its package creation date.
2025-10-01: Immich v2.0.0 stable release published.
2026: Official CLI docs describe @immich/cli installation, Docker usage, auth.yml credentials, and upload commands.

Related projects

immich-cli is part of the Immich monorepo and depends on the Immich server API. The official CLI docs recommend immich-go for Google Photos Takeout import workflows, making the two tools related but not equivalent.

Sources

security posture

Risk level: green

narrow executable package without higher-risk signals.

Risk classifier

green risk · low confidence · appliance

Why

narrow executable package without higher-risk signals

Signals

metadata:no-higher-risk-signals

Install behavior

No Homebrew post-install hook is recorded in formula metadata.
Homebrew bottle metadata is available for 1 platform targets.
Installs with 1 runtime dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

local files

Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.

Configuration files

Config paths the tool may read or write during local use.

Unix: ~/.config/immich/auth.yml

Credential files

Credential-bearing paths to review before unattended agent runs.

Unix: ~/.config/immich/auth.yml

executables

Installed executables

Command	Kind	Exposure	Note
`immich`	cli	global executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-07-08

manager version3.0.1

manager updated2026-07-04

local dataok

upstreamnot checked

latest detectednot detected

https://immich.app/docs/features/command-line-interface

infoRelease/tag comparison is only available for GitHub repositories.https://immich.app/docs/features/command-line-interfacenone confidence

install metadata

Package metadata

Package key	brew:immich-cli
Version	3.0.1
Package manager	Homebrew
Package manager page	https://formulae.brew.sh/formula/immich-cli
Homepage	https://immich.app/docs/features/command-line-interface
Repository	https://github.com/immich-app/immich
Upstream docs	https://docs.immich.app/features/command-line-interface
License	AGPL-3.0-only
Source archive	https://registry.npmjs.org/@immich/cli/-/cli-3.0.1.tgz
Last updated	2026-07-04T02:30:15Z
Pulse	updated
Dependencies	node
Bottle	available (on all)
Homebrew post-install	not defined
Service	none declared

registry facts

Source database details

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	immich-cli
Version Scheme	0
Revision	0
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	stable

source database matches

Other package-manager records

Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.

Nix95%

immich-cli

nix profile install nixpkgs#immich-cli

normalized package name match
Matched by: Immich Cli

nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/im/immich-cli/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

Nix92%

immich

nix profile install nixpkgs#immich

installed executable or alias match
Matched by: Immich

nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/im/immich/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/immich-cli.yml

Used sources

Geiger risk classifier
Nucleus package database
av.db category and tag curation
cross-ecosystem install command graph
curated configuration and credential file locations
curated package history
external package-manager database matches
package relationship graph
package version freshness
package-page enrichment

Install immich-cli with Homebrew, Nix