@teamflojo/floimg

Core engine for composable image workflows

The core FloImg package provides the pipeline engine, built-in image transforms, save providers, and CLI. Add generator plugins to create images from AI, charts, diagrams, and more.

What's Included

• Pipeline Engine — Chain generate → transform → save operations
• Image Transforms — Resize, crop, blur, sharpen, rotate, format conversion (via sharp)
• Save Providers — Filesystem and S3-compatible storage
• CLI — Command-line interface with plugin auto-install
• Fluent API — Chainable syntax for building pipelines

Installation

npm install @teamflojo/floimg

# Add generators you need
npm install @teamflojo/floimg-openai      # DALL-E + GPT-4 Vision
npm install @teamflojo/floimg-stability   # Stability AI (SDXL, SD3)
npm install @teamflojo/floimg-quickchart  # Chart.js charts
npm install @teamflojo/floimg-qr          # QR codes

Library API

Fluent API (Recommended)

Chain operations with a clean, fluent syntax:

import { floimg } from "@teamflojo/floimg";

// Load → Transform → Save
await floimg
  .from("./input.png")
  .transform("resize", { width: 800 })
  .transform("blur", { sigma: 2 })
  .to("./output.png");

// Generate → Transform → Save to cloud
await floimg
  .generate("openai", { prompt: "A sunset over mountains" })
  .transform("resize", { width: 1920 })
  .to("s3://bucket/sunset.png");

// Get the final image as a blob
const blob = await floimg
  .from("./photo.jpg")
  .transform("resize", { width: 400 })
  .transform("convert", { to: "webp" })
  .toBlob();

Client API (Fine-grained Control)

For custom configurations and AI providers:

import createClient from "@teamflojo/floimg";
import openai from "@teamflojo/floimg-openai";

const floimg = createClient();
floimg.registerGenerator(openai({ apiKey: process.env.OPENAI_API_KEY }));

// Generate → Transform → Save
const image = await floimg.generate({
  generator: "openai",
  params: {
    prompt: "A serene mountain landscape at sunset",
    model: "dall-e-3",
    size: "1024x1024",
  },
});

const resized = await floimg.transform({
  blob: image,
  op: "resize",
  params: { width: 800 },
});

await floimg.save(resized, "./landscape.png");
// Or: await floimg.save(resized, 's3://bucket/landscape.png');

CLI

# Resize and convert
npx @teamflojo/floimg resize hero.png 1200x630 -o og-image.png
npx @teamflojo/floimg convert image.png -o image.webp

# Generate charts and QR codes
npx @teamflojo/floimg chart bar --labels "Q1,Q2,Q3,Q4" --values "10,20,30,40" -o chart.png
npx @teamflojo/floimg qr "https://floimg.com" -o qr.png

# Interactive mode
npx @teamflojo/floimg

See QUICK_START.md for full CLI documentation.

Plugin Ecosystem

| Package | Description | | ------------------------------------------------------------------------------------------ | ---------------------------------------- | | @teamflojo/floimg-openai | DALL-E + GPT-4 Vision | | @teamflojo/floimg-stability | Stability AI (SDXL, SD3) + AI transforms | | @teamflojo/floimg-google | Google Imagen | | @teamflojo/floimg-replicate | Replicate models (FLUX, GFPGAN) | | @teamflojo/floimg-quickchart | Chart.js charts | | @teamflojo/floimg-mermaid | Mermaid diagrams | | @teamflojo/floimg-qr | QR codes |

MCP (AI Agents)

Use FloImg with Claude and other AI agents via MCP. Install the separate MCP package:

npm install -g @teamflojo/floimg-mcp

Configure your MCP client:

{
  "mcpServers": {
    "floimg": {
      "command": "npx",
      "args": ["-y", "@teamflojo/floimg-mcp"]
    }
  }
}

See @teamflojo/floimg-mcp for full documentation.

Documentation

• Getting Started — Installation and first steps
• SDK Reference — Full TypeScript/JavaScript API
• CLI Reference — Command-line usage
• Plugins — Generator documentation

License

MIT — Maintained by Flojo, Inc