convex-file-storage

Manage file uploads, storage, URL serving, and deletion in Convex apps.

78|18|Updated Feb 20, 2025
One-click install
npx skills add https://github.com/nakafaai/nakafa.com --skill convex-file-storage-nakafaai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-file-storage
Source: https://github.com/nakafaai/nakafa.com/tree/main/.agents/skills/convex-file-storage
Command: npx skills add https://github.com/nakafaai/nakafa.com --skill convex-file-storage-nakafaai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides end-to-end file storage in Convex applications, enabling seamless file uploads, storage, URL serving, and metadata access while ensuring proper lifecycle management.

Core Features & Use Cases

  • Upload flows: generate secure upload URLs and stream files into storage.
  • Serve and access: retrieve public or private URLs to view or download files.
  • Lifecycle management: store generated files from actions, fetch metadata, and perform deletion when needed.

Quick Start

Use the convex-file-storage skill to upload an image and retrieve its serving URL.

Frequently Asked Questions about convex-file-storage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I handle file uploads and storage in a Convex application?

File uploads and storage in a Convex application are handled by generating secure upload URLs and streaming files directly into the _storage system. You can then manage the file lifecycle through mutations, queries, and actions.

How can I get a serving URL to display or download a stored file in Convex?

To get a serving URL for a stored file in Convex, you retrieve the public or private URL associated with the file. This allows clients to directly view or download images and documents from the storage system.

Can I store generated files from server actions in Convex storage?

Yes, you can store generated files from server actions in Convex storage. The workflow supports saving generated files alongside client uploads, enabling full lifecycle management including metadata access and deletion.

How do I manage file metadata and deletion scenarios in Convex?

File metadata and deletion in Convex are managed through queries and mutations. You can fetch metadata to access file details and perform deletions when needed to properly manage the file lifecycle within your application.

Does Convex file storage support both client and server workflows?

Convex file storage supports both client and server workflows for images, documents, and generated files. It handles generating upload URLs, storing files, retrieving URLs, and managing file lifecycles across mutations, queries, and actions.