Getting Started/Installation
Docs/Getting Started/Installation

Installation

Install via npm, run zero-install via npx, and check system requirements.

Imagerry CLI is distributed as a standard npm package with precompiled native graphics engine bindings (@napi-rs/canvas) for all major operating systems.

Global Installation (Recommended)

Install globally to have the imagerry command accessible anywhere in your terminal:

|bash
npm install -g @imagerry/cli

Verify your installation:

|bash
imagerry -v
# Output: v0.2.0-beta

Alternative Package Managers

You can also install globally using pnpm or yarn:

|bash
# pnpm
pnpm add -g @imagerry/cli

# yarn
yarn global add @imagerry/cli

Zero-Install Execution (npx)

If you do not want to install the CLI globally or are running in an ephemeral CI runner, execute on-demand via npx:

|bash
npx @imagerry/cli -i screenshot.png -o styled.png --preset mesh

System Requirements

RequirementSupported Specification
Node.js RuntimeNode.js 18.0.0 or later (LTS recommended)
macOSmacOS 12+ (Apple Silicon arm64 & Intel x64)
LinuxUbuntu 20.04+, Debian 11+, Fedora, Arch (x64 & arm64)
WindowsWindows 10/11 (x64 & arm64)

Updating the CLI

To update to the latest release at any time:

|bash
npm update -g @imagerry/cli
Found an issue or typo? Report on GitHub
Imagerry CLI Docs • v0.2.0-beta