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.
2 Install the Module
Install the module you downloaded.
For details on supported operating systems and language versions, see Specifications.
Node.js
Requires Node 18 or later.
npm install ./nodeosbxl-2.0.0.tgzPython
Supports Python 3.8 and later. Modules differ between Python 3.8–3.11 and Python 3.12+, so select the appropriate wheel file for your OS and Python version.
# (e.g.) Python 3.11 (Linux)
pip install ./pyosbxl-2.0.0-cp311-cp311-linux_x86_64.whl
# (e.g.) Python 3.12+ (Linux, abi3 compatible)
pip install ./pyosbxl-2.0.0-cp312-abi3-linux_x86_64.whlJava
Requires Java 8 or later and the dependency JavaCPP (1.5.14 recommended).
Specifying Classpath Directly
javac -cp ".:osbxl-2.0.0.jar:javacpp-1.5.14.jar" Main.java
java -cp ".:osbxl-2.0.0.jar:javacpp-1.5.14.jar" MainMaven (pom.xml) Configuration Example
<dependencies>
<!-- OSBXL (Local JAR or Repository) -->
<dependency>
<groupId>com.osboffice.osbxl</groupId>
<artifactId>osbxl</artifactId>
<version>2.0.0</version>
<scope>system</scope>
<systemPath>${project.basedir}/libs/osbxl-2.0.0.jar</systemPath>
</dependency>
<!-- JavaCPP (1.5.14) -->
<dependency>
<groupId>org.bytedeco</groupId>
<artifactId>javacpp</artifactId>
<version>1.5.14</version>
</dependency>
</dependencies>PHP
PHP 8.2–8.5 (NTS builds only; thread-safe (ZTS) builds are not supported).
Pick the build matching your OS and running PHP version on the download page.
On every OS: after composer require, run the bundled installer (vendor/bin/phposbxl-install) once to finish php.ini registration.
# 1. Create and change to working directory (assuming ~/phposbxl-test)
mkdir ~/phposbxl-test && cd ~/phposbxl-test
# Place the downloaded .zip matching your OS and PHP version into ~/phposbxl-test
# 2. Configure composer artifact repository and install (no zip extraction needed)
composer config repositories.phposbxl artifact ~/phposbxl-test/
composer require osb-office/phposbxl
vendor/bin/phposbxl-install
macOS (-macosx_11_0_arm64.zip) and Windows (-win-x64.zip) differ only in file names; the steps are identical.
The installer escalates to sudo when needed and registers via ini (scan dir or php.ini). Restart FPM/Web server after installing.
※ If php / composer are not on PATH in Windows official NTS runtime, run with full path such as & "C:\php\php.exe" ... composer.phar.
※ Note: the artifact repository requires PHP's zip extension (Linux: sudo apt install php-zip, Windows: extension=php_zip.dll, etc.).
If Composer is not installed
# Install Composer using the official installer (https://getcomposer.org/) and initialize
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php --install-dir=/usr/local/bin --filename=composer
php -r "unlink('composer-setup.php');"
composer init --no-interactionUninstallation
vendor/bin/phposbxl-install --uninstall
Removes the module registration from the ini configuration file (zz-phposbxl.ini, etc.).
WebAssembly
Requires Node 24 or later.
npm install ./wasmosbxl-2.0.0.tgzWhen loading as a standalone script in browser environments:
<!-- Extract the package and load in 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.
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();Accelerate Development with AI (Cursor / Copilot / Gemini / Claude)
Instead of writing boilerplate code manually, equip your AI assistant with the official osbxl AI Skill to auto-generate accurate code directly from natural language prompts.