Quick Start with SiteOn Registry

The SiteOn Registry provides a command-line helper tool that makes integration incredibly simple for your project.

npx siteon init

pnpm dlx siteon init

bunx siteon init

What is npx siteon init?

The siteon init tool is an interactive CLI helper designed to streamline SiteOn integration into your project. It automates the setup process by guiding you through configuration, generating type-safe code, and setting you up for success in minutes.

Think of it like shadcn/ui - a fantastic project that inspired our approach to making integration accessible and developer-friendly. Thanks, shadcn team! 🙏

Supported Project Types

npx siteon init works seamlessly with:

Static Sites

Plain HTML, CSS, and JavaScript websites

Next.js/React

React applications with or without Next.js

Vue

Vue 3 and Nuxt applications

TypeScript

Any TypeScript project with npm/yarn/pnpm

How It Works

The setup process is completely interactive and guides you through each step:

1. Authentication

   • Enter your SiteOn account email
   • Provide your password for authentication

     Note: Only users with Admin role can access this

2. Workspace Selection

   • Browse and select a workspace from your SiteOn account

3. Configuration

   • Answer questions about your project structure
   • Specify which content types and forms you want to integrate

4. Code Generation

   • The tool automatically generates JavaScript/TypeScript files
   • All functions are fully typed for excellent IDE support
   • Ready-to-use fetch or axios-based implementations

5. Ready to Use

   • Import and use the generated functions in your application
   • Start fetching submissions or submitting forms immediately

Tip: The generated code is yours to own. Feel free to customize and extend it based on your project needs!