Getting Started

# Install the konik CLI globally
npm install -g @konik/cli

# Authenticate with your account
konik auth login

# Initialize a new project
konik init my-database

// Create a new schema programmatically
import { Konik } from "@konik/sdk";

const konik = new Konik({ apiKey: process.env.KONIK_API_KEY });

const schema = await konik.schemas.create({
  name: "my-app-db",
  database: "postgresql",
  description: "Main application database",
});

const users = await schema.tables.create({
  name: "users",
  attributes: [
    { name: "id", type: "uuid", primaryKey: true },
    { name: "email", type: "varchar", unique: true },
    { name: "created_at", type: "timestamp", default: "now()" },
  ],
});

// One-to-many: a user has many posts
await schema. relationships.create({
  from: "posts.user_id",
  to: "users.id",
  type: "one-to-many",
  onDelete: "cascade",
});

# Export to TypeScript (Drizzle ORM)
konik export --schema my-app-db --lang typescript --orm drizzle

# Export to Python (SQLAlchemy)
konik export --schema my-app-db --lang python --orm sqlalchemy

# Export raw SQL migrations
konik export --schema my-app-db --format sql --output ./migrations