Skip to main content

Welcome to the Docs

Get started with our platform in less than 5 minutes.

Quick Start

New here? Follow our quickstart guide to get up and running in minutes.

Explore by Topic​

🚀

Getting Started

Learn the fundamentals and set up your first project

📚

Core Concepts

Understand the key concepts and architecture

⚡

API Reference

Complete API documentation with examples

💡

Examples

Real-world examples and use cases

Quick Setup​

1

Install the CLI

Install our command-line tool globally using your preferred package manager.

npm install -g @example/cli
2

Initialize Your Project

Run the init command to create a new project with the recommended structure.

example init my-project
cd my-project
3

Start Development

Launch the development server and start building.

npm run dev

Your app is now running at http://localhost:3000.

Choose Your Path​

import { Client } from '@example/sdk';

const client = new Client({
  apiKey: process.env.API_KEY
});

const result = await client.query('Hello, world!');
console.log(result);

Frequently Asked Questions​

You can generate an API key from your dashboard. Navigate to Settings → API Keys and click "Create New Key".

Free tier accounts have a limit of 100 requests per minute. Pro accounts have 1,000 requests per minute, and Enterprise accounts have unlimited requests.

Yes! All new accounts start with a 14-day free trial of our Pro plan. No credit card required.

Important Notes​

Note

Make sure you have Node.js version 20.0 or higher installed before proceeding.

Breaking Changes in v2.0

If you're upgrading from v1.x, please review the migration guide as there are breaking changes to the API.

What's Next?​

Now that you're set up, explore more of our documentation: