Getting started

In a Next.js or React project:

npm install editsy
npm install -D @editsy/cli

The editsy package is the runtime (tiny, optional). @editsy/cli gives you the editsy command.

If your content lives under content/ as TypeScript, JSON, or markdown files (the default globs are content/*/.{ts,json,md} and src/content/*/.{ts,json,md}), there's nothing to configure. Otherwise, add an editsy.config.ts at the project root:

export default {
  content: ["content/**/*.{ts,json,md}"],
  assets: "public",
  siteUrl: "http://localhost:3000",
};

Or let npx editsy init scaffold everything at once: the config, the deployed-editor route, and a .env.example. It never touches files that already exist.

npx editsy edit

Your browser opens an editor over every content file it found. Change something, watch the preview update as you type, review the exact file diff, save. The edit lands in your file, and you commit it like any other change.

npx editsy check

Validates that content files hold only plain, serializable values (no functions, no JSX, no spreads). Exit code 1 on problems, so it slots straight into CI.

Local editing is for you. The point of editsy is the next step: serving the same editor from your deployed site, so someone non-technical can log in at yoursite.com/editsy and publish without ever hearing the word git. That's Remote mode, and it's about six steps.