Skip to main content

​
What is ReadOnly?

ReadOnly is a platform that lets you publish and manage readonly files with automatic TypeScript type generation. Store your data in the cloud, sync it to your projects, and access it with full type safety. Perfect for:
  • Configuration files
  • Content management (documents, blog posts, redirects)
  • Reference data (countries, currencies, categories)
  • Static datasets
  • Any JSON data your application needs

​
Key Features

Type-Safe

Automatic TypeScript type generation from your JSON files with full IntelliSense support.

Real-Time Sync

Watch mode automatically syncs changes from the dashboard to your local project.

Zero Runtime

Files are cached locally with no runtime overhead - just static imports.

Simple CLI

Intuitive command-line interface for syncing and managing files.

​
Quick Example

import { documents, config } from "@readonly/client";

// Fully typed with IntelliSense
console.log(documents.title);
console.log(config.apiUrl);

​
Getting Started

Quickstart

Get up and running in under 2 minutes.

Installation

Install the ReadOnly client in your project.

CLI Reference

Learn about all available commands.

Usage Guide

Learn how to import and use your files.

​
How It Works

  1. Create a Project - Sign up and create a project in the ReadOnly dashboard
  2. Add Files - Upload your JSON files through the dashboard
  3. Install Client - Add @readonly/client to your project
  4. Sync Files - Run bunx readonly sync to download and generate types
  5. Use Your Data - Import and use your files with full type safety

Need Help?

Check out our troubleshooting guide or contact support.