# Install immich-cli with Homebrew, Nix Command-line interface for self-hosted photo manager Immich. Version 3.0.1 via Homebrew; verified 2026-07-04. ## Install ```sh sudo av install brew:immich-cli ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install immich-cli ``` Evidence: local Homebrew formula metadata ### Linux - Nix (92%): ```sh nix profile install nixpkgs#immich-cli ``` Evidence: nixpkgs package indexes: pkgs/by-name/im/immich-cli/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 ## Package facts - **Package key:** brew:immich-cli - **Package manager:** Homebrew - **Package manager page:** - **Version:** 3.0.1 - **Source summary:** Command-line interface for self-hosted photo manager Immich - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** AGPL-3.0-only - **Source archive:** - **Last updated:** 2026-07-04T02:30:15Z - **Generated:** 2026-07-08T18:08:21+00:00 ## Executables - immich (cli) - immich (alias) ## Dependencies - node ## Install behavior - Post-install hook: not defined - Bottle: available on all ## Freshness - Page generated: 2026-07-08 - Package-manager version: 3.0.1 - Package-manager updated: 2026-07-04 - Local data: ok - Upstream repository: https://immich.app/docs/features/command-line-interface - info: Release/tag comparison is only available for GitHub repositories. ## 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 Notes narrow executable package without higher-risk signals. - **Geiger risk:** green / low - narrow executable package without higher-risk signals ## 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 - Unix: ~/.config/immich/auth.yml ## Credential files - Unix: ~/.config/immich/auth.yml ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** immich-cli - **Version Scheme:** 0 - **Revision:** 0 - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## Other Package-Manager Records - Nix - immich-cli: normalized package name match | nixpkgs package indexes: pkgs/by-name/im/immich-cli/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - Nix - immich: installed executable or alias match | nixpkgs package indexes: pkgs/by-name/im/immich/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 ## Related links - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Archive and compression packages](https://www.automicvault.com/pkg/archive-compression-tools/) - Matched archive or compression metadata. - [Networking and protocol packages](https://www.automicvault.com/pkg/networking-protocol-tools/) - Matched network, protocol, or remote-service metadata. - [Media and graphics packages](https://www.automicvault.com/pkg/media-graphics-tools/) - Matched media, image, audio, video, or graphics metadata. - [node](https://www.automicvault.com/pkg/brew/node/) - Runtime dependency declared by Homebrew. - [immich-go](https://www.automicvault.com/pkg/brew/immich-go/) - Shares av.db curated category or tags: cli, immich, media, photos. - [gphotos-uploader-cli](https://www.automicvault.com/pkg/brew/gphotos-uploader-cli/) - Shares av.db curated category or tags: backup, cli, media, upload. - [dvdbackup](https://www.automicvault.com/pkg/brew/dvdbackup/) - Shares av.db curated category or tags: backup, cli, media. - [ente-cli](https://www.automicvault.com/pkg/brew/ente-cli/) - Shares av.db curated category or tags: cli, media, photos. - [exif](https://www.automicvault.com/pkg/brew/exif/) - Shares av.db curated category or tags: cli, media, photos. - [instaloader](https://www.automicvault.com/pkg/brew/instaloader/) - Shares av.db curated category or tags: cli, media, photos. - [instalooter](https://www.automicvault.com/pkg/brew/instalooter/) - Shares av.db curated category or tags: cli, media, photos. - [a52dec](https://www.automicvault.com/pkg/brew/a52dec/) - Shares av.db curated category or tags: cli, media. - [lanraragi](https://www.automicvault.com/pkg/brew/lanraragi/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, hosted, manager, media, node. ## Combined YAML source View the package source record on GitHub. [combined/immich-cli.yml](https://github.com/automic-vault/db/blob/main/combined/immich-cli.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - av.db category and tag curation - package relationship graph - external package-manager database matches - cross-ecosystem install command graph