# SDK

<p align="center">
  <a href="https://www.sheetxl.com" target="_blank">
    <img src="https://www.sheetxl.com/logo-text.svg" alt="SheetXL Logo" width="180" />
  </a>
</p>

A high-performance, embeddable spreadsheet engine for TypeScript and JavaScript.
This package provides the **SDK**, designed for embedding spreadsheet functionality directly into applications.

SheetXL handles large and sparse datasets with an efficient columnar model and provides a powerful calculation engine with a clean, flexible API. As a zero-dependency headless library, it integrates easily into any tech stack.

* Read / write cell data
* Excel-class calculation engine
* Styling & formatting model
* Headless execution (bring your own UI)
* Designed for large, sparse datasets

Part of the [SheetXL ecosystem](https://www.sheetxl.com), which also includes UI components and import/export tools.

---

## Installation

```bash
pnpm install @sheetxl/sdk
```

## Quick Start

```ts
import { Workbook } from "@sheetxl/sdk";

// Create a workbook
const wb = new Workbook();
const sheet = wb.addSheet("Demo");

// Write values
sheet.getRange("A1").setValue(42);
sheet.getRange("B1").setValue(2);

// Formula
sheet.getRange("C1").setFormula("=A1*B1");

// Read result
console.log(sheet.getRange("C1").getValue()); // 84

```

## CLI

For quick scripts or inspection, you can also run SheetXL directly without installation:

```bash
npx sheetxl
```

## 🔗 Learn More

Whether you're ready to build, need help, or just want to see more examples, here's where to go next.

* 💬 **[Join our Discord Community](https://discord.gg/NTKdwUgK9p)** - Get help and connect with the team.
* ⭐ **[Star us on GitHub](https://github.com/sheetxl/sheetxl)** - If you like SheetXL give us a star ⭐ and help others find us!
* 📘 **[Developer Docs](https://www.sheetxl.com/docs)** - Guides and tutorials.
* 🔌 **[API Reference](https://api.sheetxl.com)** - Detailed documentation for all packages.
* 👀 **[Live Demo Gallery](https://www.sheetxl.com/demos)** - A showcase of interactive examples.
* 🖼️ **[Storybook](https://storybook.sheetxl.com)** - Explore and test individual UI components.
* 🌐 **[Website](https://www.sheetxl.com)** - Our Website.

---