commands

package
v0.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2026 License: MIT Imports: 26 Imported by: 0

Documentation

Overview

Package commands defines the CLI command tree. One file per OpenAPI spec tag; commands are grouped as `<tag> <operation>` (e.g. `users me`).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Albums

func Albums() *cli.Command

Albums returns the `albums` command group (spec tag: Albums).

func Assets

func Assets() *cli.Command

Assets returns the `assets` command group (spec tag: Assets).

func ClientWorkflow

func ClientWorkflow() *cli.Command

ClientWorkflow returns the `client-workflow` command group (alias `cw`): multi-step orchestrations that run entirely client-side, combining several Immich API calls with local processing. Not to be confused with Immich's own server-side "Workflows" API tag.

func ImmichWorkflow

func ImmichWorkflow() *cli.Command

ImmichWorkflow returns the `immich-workflow` command group (spec tag: Workflows): thin wrappers over Immich's own server-side workflows API (listing workflows and reading their run logs). Not to be confused with `client-workflow` (alias `cw`), the client-side multi-step orchestrations that are this tool's main purpose. The plural `workflows` alone is deliberately not used as a group name to keep the two concepts apart.

func Search() *cli.Command

Search returns the `search` command group (spec tag: Search).

func Skill

func Skill() *cli.Command

Skill returns the `return-agent-skill` top-level command: it prints a SKILL.md agent skill for this CLI (frontmatter, a command catalog generated from the live command tree, and best practices). Fully offline: it never contacts the server and needs no config.

func Tags

func Tags() *cli.Command

Tags returns the `tags` command group (spec tag: Tags).

func Update

func Update(version string) *cli.Command

Update returns the `update` command: it checks the latest GitHub release for a build matching the current OS/arch and, on confirmation, replaces the running executable in place and restarts it.

Release assets are named "immich-admin_<os>_<arch>[.exe]" with no version in the filename (see .github/workflows/release.yml) — embedding the version there would go stale the moment the binary updates itself in place, since the file keeps its original name.

func Users

func Users() *cli.Command

Users returns the `users` command group (spec tag: Users).

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL