create-sheetxl

Overview

Official scaffolding tool for SheetXL — the API-first, Excel-compatible spreadsheet engine.

🚀 Get Started

Compatibility Note:
SheetXL requires Node.js version 20.19+ or 22.12+.
Some templates (e.g. React) may require higher versions. Upgrade if your package manager warns you.

Using your preferred package manager

npm create sheetxl@latest
pnpm create sheetxl
yarn create sheetxl

Then follow the prompts to pick a template and get started!

🧪 Template Presets

You can also skip the prompt and specify everything inline. For example:

npm create sheetxl my-spreadsheet -- --template react

Currently supported templates:

• react — React + Typescript + VSCode Launcher
• node — Node + Typescript + VSCode Launcher
• vanilla — Vanilla Typescript + VSCode Launcher
• vanilla cdn — Minimal Browser only examples.

💡 Use . as the project name to scaffold into the current directory.

Additional Resources

• ⭐ Github - Our github projects.
• 💬 Join our Discord Community - Get help and connect with the team.
• 🌐 Website - The official website for SheetXL.
• 📘 Developer Docs - The official guides and tutorials.

📜 Changelog

For a complete list of changes, features, and bug fixes, see the CHANGELOG.md.

📄 License

This template project is licensed under the MIT License.

Note: SheetXL components may be subject to additional commercial licensing. See SheetXL licensing for details.