Getting Started

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

# Authenticate with your account
skemio auth login

# Initialize a new project
skemio init my-database

// Create a new schema programmatically
import { Skemio } from "@skemio/sdk";

const skemio = new Skemio({ apiKey: process.env.SKEMIO_API_KEY });

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

// Add a users table
await skemio.tables.create(schema.id, {
  name: "users",
  attributes: [
    { name: "id", type: "uuid", primaryKey: true, default: "gen_random_uuid()" },
    { name: "email", type: "varchar(255)", unique: true, notNull: true },
    { name: "name", type: "varchar(255)", notNull: true },
    { name: "created_at", type: "timestamp", default: "now()" },
  ],
});

// Define a one-to-many relationship
await skemio.relationships.create(schema.id, {
  from: { table: "users", attribute: "id" },
  to: { table: "posts", attribute: "author_id" },
  type: "one-to-many",
  onDelete: "CASCADE",
});

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

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

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