Getting Started/Quickstart
Docs/Getting Started/Quickstart

Quickstart

Get up and running with Imagerry CLI in under 60 seconds.

Imagerry CLI is a high-performance command-line tool and local HTTP REST API microservice designed to process, style, and generate image assets 100% locally on your machine.

1. Global Installation via npm

Install the CLI globally on your machine using npm:

|bash
npm install -g @imagerry/cli

2. Style Your First Image

Pass an input image and render it with the built-in mesh preset:

|bash
imagerry -i screenshot.png -o styled.png --preset mesh
Security & Privacy

100% Local & Private Processing

Imagerry operates completely on your local machine using a compiled native Skia graphics engine (@napi-rs/canvas). Your image files are never uploaded to any remote server or third-party cloud.

What's Next?

  • Explore CLI Commands: Learn about aspect ratios, padding, and quality controls.
  • REST API Server: Host a local HTTP API server for your backend with imagerry serve.
  • Presets & Templates: Customize designs with built-in presets and JSON templates.
Found an issue or typo? Report on GitHub
Imagerry CLI Docs • v0.1.6-beta