Quick Start

Get up and running with osbxl

1 Download the Demo

Download the demo build for your language and OS from the download page on this site.

📥
Supported Platforms
Java / Python / Node.js / WebAssembly
Linux / Windows / macOS (Apple Silicon)
Go to Download Page

2 Install the Module

Install the module you downloaded.

※ The examples below are for Linux. Windows / macOS work the same way except for file names.

Node.js

npm install ./nodeosbxl-1.5.0.tgz

Python

Choose the wheel file matching your Python version on the download page.

(e.g.) Python 3.11
pip install ./pyosbxl-1.5.0-cp311-cp311-linux_x86_64.whl

(e.g.) Python 3.12+
pip install ./pyosbxl-1.5.0-cp312-abi3-linux_x86_64.whl

Java

# Add the JAR to your classpath
java -cp osbxl-1.5.0.jar:your-app.jar YourMainClass

WebAssembly

# Extract the package
tar xzf wasmosbxl-1.5.0.tgz
<!-- Load the extracted osbxl_wasm.js in your HTML -->
<script src="osbxl_wasm.js"></script>
⚠️

Demo Version Notice

osbxl runs as a demo version until a license is activated.
In the demo version, you can only add or modify the first 30 rows of each Excel spreadsheet.
Writes beyond row 30 are restricted (reading is not restricted).
To use osbxl without limits, please activate a license.

3 Activate Your License

After purchase, the license file is sent to you by email. Configure it following the License Setup Guide (member login required), and all features become available without limits.

🔑
License Setup
How to configure the license file sent to you (member login required)
License Setup Guide

4 Start Developing Right Away

You can start developing and testing with the demo version immediately, even before activation.
Please review the demo restriction (only the first 30 rows are editable) and try osbxl with the demo first.
Activate your license when you are ready for production use.

const osbxl = require("osbxl");

const app = new osbxl.App();
const book = app.createWorkBook("/tmp/demo.xlsx");
const sheet = book.addWorkSheet("Sheet1");

sheet.getRange("A1").setNumberValue(100);
sheet.getRange("A2").setNumberValue(200);
sheet.getRange("A3").setFormula("SUM(A1:A2)");

const values = sheet.getRange("A3").getValue();
console.log(values["A3"]); // "300"

book.save();
book.close();