Skip to content
SumOfficeSumOfficeSumOffice
Menu
What SumOffice isProduct and deliveryAI and MCPContact us
Overview
SumSheet — what it isCapability map next to ExcelArchitecture: four layers and objectsWhat happens from open to saveStrengths and tradeoffs
Getting started
Installing SumSheetQuick start: your first project
Guides
How the API session worksRequests used in the exampleResponding to clicks and the context menuIntegrating into an applicationEmbedding kit: structure, events, menuSurface eventsDiagnosticsVerified script
Runtimes
The core in the browser through WebAssemblyA separate core process alongside your applicationSumSheet as a server-side processorPhone and tabletRuntime environments and the end-to-end scenario
Contract and boundaries
Readiness checklistFrom concept to pilotSumSheet version history
Examples
Live example: a budget spreadsheetSumSheet examplesMinimal sheetSheet with the ribbonEmbedding into a third-party pageA million rowsCrosshairRead-onlyCustom headersSheet without header stripsCustom menu itemCustom keyboard shortcutCustom languageDrop a workbook hereTwo people in one documentAssistants drive the sheetCustom eventHyperlinkFind and replaceNotesSheet outlinePage layoutAllow editing rangesWorkbook linksHeadless
Reference
SumSheet referenceSumSheet transport and message formatSumSheet session and conventionsWhat you can do with each formatSession and workbookCells and rangesSheetsPrinting and layoutFormulas and calculationFormattingData, filters, and objectsPivot tablesPower Query: M expressionsPower Query: connectorsPower Query: queries and stepsPower Query: tables from queriesPower Query: execution and progressPower Query: trust and privacyPower Query: external mashupsVBA and macrosProtection and reviewTypes: session, workbook, and sheetsTypes: cells and rangesTypes: formulas and calculationTypes: formattingTypes: data and sheet objectsTypes: pivot tablesTypes: charts and graphicsTypes: printing and page layoutTypes: Power QueryTypes: VBA and macrosTypes: protection and reviewTypes: general and utility

Quick start: your first project

Prepare a folder, add a workbook and a script, run the example, and see the result.

Prepare your first project

Section titled “Prepare your first project”

You’ll need Node.js version 22 LTS or newer and any XLSX workbook. The ready-made kit on the desktop already has input.xlsx and the verified f1-api-first-run.mjs.

Create a folder

Section titled “Create a folder”
Terminal window
mkdir -p ~/Desktop/SumSheet-API-First-Run
cd ~/Desktop/SumSheet-API-First-Run

Add the source workbook

Section titled “Add the source workbook”

Copy an existing workbook and name it input.xlsx. The script doesn’t change the source file: it writes a new result.xlsx.

Terminal window
cp ~/Downloads/workbook.xlsx ./input.xlsx
ls -lh input.xlsx

Add the script

Section titled “Add the script”

Use the f1-api-first-run.mjs file from the Evaluation Kit. The full text is on the Verified script page.

Run the example

Section titled “Run the example”
Terminal window
cd ~/Desktop/SumSheet-API-First-Run
node ./f1-api-first-run.mjs

The script performs seven steps:

  • starts compute_contract_cli –session and gets the handshake;

  • opens input.xlsx through open_workbook_subset;

  • gets subsetId and sheetKey from Rust’s response;

  • writes A1 = SumSheet API, B1 = 21, C1 = the formula =B1*2;

  • reads C1 and gets displayValue 42;

  • performs Undo and Redo through the central history;

  • saves result.xlsx, starts a new process, and checks C1 after a cold open.

Expected output

Section titled “Expected output”
1. Session: compute_contract_cli_session_ready
2. Workbook opened: Data subset-...
3. Changes applied, revision: 1
4. C1 after the formula: ... displayValue: '42' ...
5. Undo/Redo: done
6. Saved: .../result.xlsx
7. Reopened, C1: ... displayValue: '42' ...

See the result

Section titled “See the result”
Terminal window
open -a ~/Applications/SumSheet.app ~/Desktop/SumSheet-API-First-Run/result.xlsx

What’s next

Section titled “What’s next”

Documentation assistant

Answers are assembled from the documentation and may be inaccurate — check the sources.