Built for AdonisJS 7

File uploads that
stay simple.

Store files, generate image variants, and persist them with Lucid - without coupling your models to the framework. Everything optional is opt-in.

Get started in 5 min Read the guide GitHub

users_controller.ts

// From an upload to a stored, model-owned file:
import { attachmentManager } from '@jrmc/adonis-attachment'

const avatar = await attachmentManager.createFromFile(
  request.file('avatar')!
)

user.avatar.set(avatar) // stage it
await user.save() // stored + persisted

From upload to URL, in four steps

Create

Turn an upload, buffer, URL, or stream into a draft.

Store

Write the bytes to local disk, S3 via Drive, or your own backend.

Persist

Save ownership with Lucid - or any data store you like.

Serve

Stream the file back, with optional image variants.

One value, many sources

Uploads, buffers, Base64, paths, URLs, streams - always the same tiny API.

Storage you choose

Local filesystem out of the box, Adonis Drive when you scale, or a custom adapter.

Image variants

Thumbnails and responsive sizes with your own image library, inline or queued.

Persistence, your way

Lucid blob + link tables, a JSON column, or plain values in another ORM.

Persist it your way

With Lucid

Blob + polymorphic link tables for ownership, ordered collections, variants, and cross-record blob reuse. A JSON-column mode is available for the simplest case.

With any data store

Keep the plain Attachment value in Prisma, Kysely, raw SQL - or nothing. The package imposes no schema.

Ready to attach your first file?

Install, configure once, and ship uploads in minutes.

Open the quickstart

File uploads thatstay simple.