Installation

Install the Core Package

npm install @teamflojo/floimg

Or with your preferred package manager:

pnpm add @teamflojo/floimg
yarn add @teamflojo/floimg

Add Plugins

floimg uses a plugin architecture. Install only the generators you need:

# Charts via Chart.js
npm install @teamflojo/floimg-quickchart

# Mermaid diagrams
npm install @teamflojo/floimg-mermaid

# QR codes
npm install @teamflojo/floimg-qr

# D3 visualizations
npm install @teamflojo/floimg-d3

# Screenshots via Playwright
npm install @teamflojo/floimg-screenshot

Verify Installation

Create a simple test file:

test.ts

import createClient from '@teamflojo/floimg';
import qr from '@teamflojo/floimg-qr';

const floimg = createClient();
floimg.registerGenerator(qr());

const qrCode = await floimg.generate({
  generator: 'qr',
  params: { text: 'https://floimg.com' }
});

await floimg.save(qrCode, './test-qr.png');
console.log('QR code saved to test-qr.png');

Run it:

npx tsx test.ts

You should see a QR code saved to test-qr.png.

Next Steps

• Quick Start - Build your first workflow
• Core Concepts - Understand how floimg works
• Plugins - Explore available generators