Getting Started/Installation
Docs/Getting Started/Installation

Installation

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

Imagerry CLI is available both as standalone native binaries (zero runtime or Node.js dependencies required) and as a standard npm package with precompiled native Skia graphics engine bindings (@napi-rs/canvas).

Option 1: Standalone Binary (Zero Node.js Required)

Recommended for Docker containers, CI/CD runners, lightweight servers, or users without Node.js installed.

macOS & Linux

|bash
curl -fsSL https://imagerry.com/cli/install.sh | bash

Windows (PowerShell)

|powershell
irm https://imagerry.com/cli/install.ps1 | iex

The installer automatically detects your operating system and CPU architecture, downloads the precompiled binary alongside the native Skia graphics library, and places imagerry into your system PATH.

Option 2: Global Installation via npm (Node.js)

If you already have Node.js (18+) installed on your system:

|bash
npm install -g @imagerry/cli

Verify your installation:

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

Alternative Package Managers

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

# yarn
yarn global add @imagerry/cli

Option 3: Zero-Install Execution (npx)

If you do not want to install the CLI globally or are running in an ephemeral CI runner:

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

Supported Architectures & Operating Systems

Operating SystemArchitectureStandalone Binarynpm / npx Package
macOS (12+)Apple Silicon (arm64)
macOS (12+)Intel (x64)
Linux (Ubuntu, Debian, Fedora, Arch)x64 (glibc 2.27+)
Linux (Ubuntu, Debian, Fedora, Arch)arm64 (aarch64)
Windows (10 / 11)x64
Windows (10 / 11)arm64
Android (Termux)arm64

Updating the CLI

Standalone Binary

Rerun the installer script to automatically fetch and verify the latest binary in-place:

|bash
curl -fsSL https://imagerry.com/cli/install.sh | bash

npm Package

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