Getting Started

Prerequisites

• •Node.js 18+ — required for the TypeScript SDK and build tooling
• •pnpm (recommended) — or npm / yarn as your package manager
• •A modern browser with WebAssembly support (Chrome, Firefox, Safari, Edge)
• •Rust toolchain (optional) — only needed if building the compute engine from source

Installation

These packages are not yet published. They will be available at launch.

Install the Mog SDK with your preferred package manager:

npm install @mog-sdk/node

docker run -p 3000:3000 ghcr.io/mog-project/mog:latest

brew install mog

Quick Start

Follow these steps to create and render your first Mog spreadsheet.

# npm
npm install @mog-sdk/node

# pnpm
pnpm add @mog-sdk/node

import { createWorkbook } from "@mog-sdk/node";

const wb = await createWorkbook();
const ws = wb.getActiveSheet();

await ws.setCell("A1", "Revenue");
await ws.setCell("A2", 150000);
await ws.setCell("A3", 230000);
await ws.setCell("A4", "=SUM(A2:A3)");

await wb.calculate();
const total = await ws.getValue("A4");
console.log(total); // 380000

import { MogSheet } from "@mog-sdk/embed/react";

export function App() {
  return (
    <MogSheet
      src="/data/sales.xlsx"
      width={1200}
      height={600}
    />
  );
}

import { createWorkbook, save } from "@mog-sdk/node";

const wb = await createWorkbook();
const ws = wb.getActiveSheet();

await ws.setCell("A1", "Hello");
await ws.setCell("B1", "=LEN(A1)");

await save(wb, "output.xlsx");

Building from Source

The repository is not yet public. This section previews the setup process.

To build Mog from source, clone the repository and use pnpm to install dependencies and start the development server.

git clone https://github.com/mog-project/mog
cd mog
pnpm install
pnpm build
pnpm dev

This requires Node.js 18+ and pnpm. The Rust compute engine will be compiled to WebAssembly during the build step if a Rust toolchain is available.

Next Steps