bilig-workpaper
v0.40.42
Published
Bilig WorkPaper runtime for Node.js services, agent tools, and server-side spreadsheet formulas.
Maintainers
Keywords
Readme
bilig-workpaper
Bilig WorkPaper runtime for Node.js services, agent tools, and server-side spreadsheet formulas.
This is the unscoped npm entrypoint for the Bilig headless runtime. Use it when business logic is easiest to review as workbook cells and formulas, but the calculation needs to run in a backend service, queue worker, serverless route, test, or coding-agent tool.
Install
npm install bilig-workpaperUse A WorkPaper In Node
import { WorkPaper } from 'bilig-workpaper'
const workbook = WorkPaper.buildFromSheets({
Inputs: [
['Metric', 'Value'],
['Units', 40],
['Price', 1200],
],
Summary: [
['Metric', 'Value'],
['Revenue', '=Inputs!B2*Inputs!B3'],
],
})
const inputs = workbook.getSheetId('Inputs')
const summary = workbook.getSheetId('Summary')
if (inputs === undefined || summary === undefined) {
throw new Error('Expected sheets to exist')
}
workbook.setCellContents({ sheet: inputs, row: 1, col: 1 }, 48)
workbook.setCellContents({ sheet: inputs, row: 2, col: 1 }, 1500)
console.log(workbook.getCellValue({ sheet: summary, row: 1, col: 1 }))
console.log(workbook.exportSnapshot())
workbook.dispose()XLSX Import And Export
import { WorkPaper } from 'bilig-workpaper'
import { exportXlsx, importXlsx } from 'bilig-workpaper/xlsx'Use xlsx-formula-recalc when you only need to edit and recalculate XLSX files. Use exceljs-formula-recalc when you already use ExcelJS and need recalculated formula results after changing inputs.
Agent Commands And Optional MCP
The npm tarball includes AGENTS.md, SKILL.md, and the same CLI entrypoints
as @bilig/headless, so agents can inspect node_modules/bilig-workpaper
without discovering the scoped package first.
import { createWorkPaperMcpServer } from 'bilig-workpaper/mcp'For package-owned proof commands, use:
npm exec --package bilig-workpaper -- bilig-agent-challenge
npm exec --package bilig-workpaper -- bilig-mcp-challenge
npm exec --package bilig-workpaper -- bilig-workpaper-mcp --workpaper ./pricing.workpaper.json --init-demo-workpaper --writableFor a runnable starter project, use npm create @bilig/workpaper.
Scope
Bilig is not a desktop Excel clone. It is a formula workbook runtime for service-owned calculations, JSON persistence, XLSX import/export, and agent-readable readback. Unsupported Excel functions, external workbook links, macros, and volatile functions may need review.
Full docs: https://proompteng.github.io/bilig/
