PSImmich

KO | EN

gitlite — search

#javascript #typescript #llm #go #golang #rust #deep-learning #macos #java #windows #awesome #pytorch #ios #openai

(★ 17)

PSImmich is a Powershell API wrapper for Immich

PSImmich Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PSImmich

This project has adopted the following policies [![CodeOfConduct](https://img.shields.io/badge/Code%20Of%20Conduct-gray)](https://github.com/hanpq/PSImmich/blob/main/.github/CODE_OF_CONDUCT.md) [![Contributing](https://img.shields.io/badge/Contributing-gray)](https://github.com/hanpq/PSImmich/blob/main/.github/CONTRIBUTING.md) [![Security](https://img.shields.io/badge/Security-gray)](https://github.com/hanpq/PSImmich/blob/main/.github/SECURITY.md)

## Project status
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/hanpq/PSImmich/build.yml?branch=main&label=build&logo=github)](https://github.com/hanpq/PSImmich/actions/workflows/build.yml) [![Codecov](https://img.shields.io/codecov/c/github/hanpq/PSImmich?logo=codecov&token=qJqWlwMAiD)](https://codecov.io/gh/hanpq/PSImmich) [![Platform](https://img.shields.io/powershellgallery/p/PSImmich?logo=ReasonStudios)](https://img.shields.io/powershellgallery/p/PSImmich) [![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/PSImmich?label=downloads)](https://www.powershellgallery.com/packages/PSImmich) [![License](https://img.shields.io/github/license/hanpq/PSImmich)](https://github.com/hanpq/PSImmich/blob/main/LICENSE) [![docs](https://img.shields.io/badge/docs-getps.dev-blueviolet)](https://getps.dev/modules/PSImmich/getstarted) [![changelog](https://img.shields.io/badge/changelog-getps.dev-blueviolet)](https://github.com/hanpq/PSImmich/blob/main/CHANGELOG.md) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/hanpq/PSImmich?label=version&sort=semver) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/hanpq/PSImmich?include_prereleases&label=prerelease&sort=semver) ![Static Badge](https://img.shields.io/badge/80%25%20(131%2F172)-green?label=API%20Coverage) ![Static Badge2](https://img.shields.io/badge/2077-green?label=Unit%2FQuality%2FIntegration%20tests)

## About

PSImmich is a Powershell API wrapper for Immich

## Installation

### PowerShell Gallery

To install from the PowerShell gallery using PowerShellGet run the following command:

```powershell
Install-Module PSImmich -Scope CurrentUser
```

## Usage

Before calling the Immich cmdlets a session needs to be created. Currently it is supported to use an API key or credentials (username and password)

```powershell
Connect-Immich -BaseURL 'https://immich.domain.com' -AccessToken 'ztKkvGWVIacJATX7RLCbWCISpamwEQkLpakn8O48acE'
```

```powershell
$Cred = Get-Credential
Connect-Immich -BaseURL 'https://immich.domain.com' -Credential $Cred
```

You can verify that the connection is working by calling `Get-IMSession` and verifying that `AccessTokenValid` is `true`

```powershell
Get-IMSession

BaseUri          : https://immich.domain.com
AuthMethod       : AccessToken
AccessToken      : System.Security.SecureString
AccessTokenValid : True
Credential       : 
JWT              : 
APIUri           : https://immich.domain.com/api
ImmichVersion    : 1.98.2
SessionID        : 67055f46-51aa-42a2-8471-46170c441558
```

The session object can be passed to all cmdlets. This is useful if connection to more than one Immich instance is needed.

```powershell
$Session1 = Connect-Immich -BaseURL 'https://immich.domain.com' -AccessToken 'ztKkvGWVIacJATX7RLCbWCISpamwEQkLpakn8O48acE' -PassThru

Get-IMAsset -Session $Session1
```

To see available cmdlets you can use the following command

```powershell
Get-Command -Module PSImmich  | Format-Wide -Column 4 -Property Name

Add-IMActivity     Add-IMAlbumAsset          Add-IMAlbumUser    Add-IMAsset
Add-IMAssetTag     Add-IMMyProfilePicture    Add-IMPartner      Add-IMSharedLinkAsset 
...
...

```

## Available commands

For documentation about each command please see the [docs](https://getps.dev/modules/PSImmich)

## Versioning

PSImmich follows Immich's versioning scheme to indicate compatibility:

- **Major.Minor versions match Immich** - PSImmich 2.3.x is developed and tested against Immich 2.3.x
- **Patch version starts with Immich's patch number** - If Immich releases 2.3.1, PSImmich starts at 2.3.1  
- **Subsequent PSImmich releases increment the patch** - Additional PSImmich updates become 2.3.2, 2.3.3, etc. until the next Immich version is released.

This ensures you can easily identify which Immich version is supported by checking the first two version numbers.

PSImmich

PSImmich Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

PSImmich

PSImmich Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README