Quick Start (Node)
SheetXL for Node lets you create, modify, and save spreadsheet workbooks entirely server-side—perfect for automation, serverless, or offline processing.
New Project
The fastest way to get started with SheetXL is using our project wizard. It will create a new project with SheetXL pre-configured and ready to use.
- pnpm
- yarn
- npm
pnpm create sheetxl@beta
yarn create sheetxl@beta
npx create-sheetxl@beta
...and follow the interactive prompts.
Existing Project
Install the SDK and IO packages using your preferred package manager:
- pnpm
- yarn
- npm
pnpm add @sheetxl/sdk@beta @sheetxl/io@beta
yarn add @sheetxl/sdk@beta @sheetxl/io@beta
npm install @sheetxl/sdk@beta @sheetxl/io@beta
Installation
Create a file called example.js:
example.js
import { LicenseManager, Workbook, WorkbookIO } from '@sheetxl/sdk';
import { IOPlugin } from '@sheetxl/io';
// Set your license key or use CLI to install
LicenseManager.setLicenseKey('visit https://my.sheetxl.com after trial.');
// Register the file format handlers (xlsx, csv, …) once at startup
await WorkbookIO.install(IOPlugin);
// Create a new workbook
const workbook = new Workbook();
workbook.getRange('A1').setValues([['Hello World!']]);
// Write to disk — the extension drives the format
await WorkbookIO.write(workbook, 'my-workbook.xlsx');
console.log('Workbook saved as my-workbook.xlsx');
Run it with:
node example.js
API Documentation
See the full API reference for all available methods: