Install

Get started with generate-metadata by installing it in your project.

Package Installation

Install the generate-metadata package using your preferred package manager:

  npm install generate-metadata

Verification

To verify the installation was successful, try importing the client:

import { GenerateMetadataClient } from "generate-metadata/next";
 
// If this imports without errors, you're ready for setup!

TypeScript Configuration

For optimal compatibility, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "moduleResolution": "bundler", // Required for subpath imports
    "allowSyntheticDefaultImports": true, // Recommended
    "esModuleInterop": true, // Recommended
    "strict": true // Recommended for best type safety
  }
}

Requirements

• Node.js: Version 16 or higher
• TypeScript: Version 5.0 or higher (recommended)
• Framework: Next.js 13+ or TanStack Start 1.0+

Framework Support

Generate-metadata provides framework-specific imports for optimal integration:

• Next.js: generate-metadata/next
• TanStack Start: generate-metadata/tanstack-start

Get Your DSN

Before proceeding with setup, you'll need a DSN (Data Source Name) from generate-metadata.com.

The DSN identifies your project and enables AI-powered metadata generation. Sign up to get your free DSN and start optimizing your SEO metadata.

Next Steps

Once installed, follow the setup guide for your framework: