Quickstart

1. Create your site

Sign up at app.dyrected.com and create a new Site.

2. Copy the AI Prompt

Immediately after creating your site, you will see a Setup Prompt. This is pre-filled with your Site ID and API Key.

3. Give it to your AI

Paste that prompt into your AI tool (Claude, GPT, Cursor, etc.).

The AI will automatically:

• Install the necessary dependencies (@dyrected/admin, @dyrected/core).
• Create a dyrected.config.ts with your initial collections.
• Embed the Admin Dashboard directly into your React, Vue, or Next.js application at a route like /admin.
• Sync your Schema: The AI will run npx @dyrected/cli sync:schema for you so your cloud database is ready immediately.

4. Build and ship

Run your site and your new dashboard will be live at yourwebsite.com/admin.

The easiest way to get started with Next.js is using the interactive CLI.

1. Initialize

npx @dyrected/cli init

Choose Next.js and SQLite (for local development). The CLI will:

• Install @dyrected/core, @dyrected/next, and @dyrected/db-sqlite.
• Create a dyrected.config.ts.
• Mount the API route at app/dyrected/[...route]/route.ts.
• Mount the Admin UI at app/cms/[[...route]]/page.tsx.
• Generate a .env.example.

2. Configure and Run

1. Copy .env.example to .env and set DYRECTED_JWT_SECRET.
2. Run pnpm dev.
3. Open http://localhost:3000/cms to start managing content.

The easiest way to get started with Nuxt is using the interactive CLI.

1. Initialize

npx @dyrected/cli init

Choose Nuxt 3 and SQLite. The CLI will:

• Install dependencies and create dyrected.config.ts.
• Mount the Admin UI at pages/cms/[[...route]].vue.
• Generate a .env.example.

2. Configure and Run

1. Register the module: Add '@dyrected/nuxt' to your modules in nuxt.config.ts.
2. Environment: Copy .env.example to .env and configure your secrets.
3. Run: Start your project with pnpm dev.
4. Dashboard: Open http://localhost:3000/cms to start managing content.