Office Bridge

Execute Office.js JavaScript in open Office applications. Maintains persistent WebSocket connections to Office add-ins.

Quick Start

1. Run ./office-bridge/install.sh (first time only)
2. Start bridge server: ./office-bridge/server.sh &
3. Start app dev server (see ports below)
4. Open Office app, click Office Bridge add-in

For sideloading help, see references/setup.md.

Connection Pattern

import { connect } from "./src/client.js";

const bridge = await connect();
const sessions = await bridge.sessions();           // All apps
const docs = await bridge.documents();              // Word (with helpers)
const workbooks = await bridge.excel();             // Excel
const presentations = await bridge.powerpoint();   // PowerPoint
const mail = await bridge.outlook();               // Outlook

// Execute code in any session
const result = await session.executeJs(`
  // App-specific code here
  await context.sync();
  return data;
`);

await bridge.close();

Ports

Component	Port
Bridge Server	3847
Word	3000
Excel	3001
PowerPoint	3002
Outlook	3003

Start a dev server: cd office-bridge/addins/<app> && npm run dev-server &

Troubleshooting

• No sessions: Open Office app → click Office Bridge add-in
• Add-in missing: See references/setup.md
• Execution failed: Check Office.js syntax, use try/catch

References

• references/setup.md - Sideloading and installation steps
• references/word.md - Word patterns and accessibility helpers
• references/excel.md - Excel workbook and range operations
• references/powerpoint.md - PowerPoint slide and shape operations
• references/outlook.md - Outlook mail and calendar access

Reporting Issues

If you encounter connection problems, Office.js errors, or want to request new features, use the GitHub CLI:

# Report a bug
gh issue create --repo SanctionedCodeList/office-bridge --title "Bug: [description]" --body "## Problem\n[Describe the issue]\n\n## Office app affected\n[Word/Excel/PowerPoint/Outlook]\n\n## Error message\n[Include any error output]\n\n## Steps to reproduce\n[How to trigger it]"

# Request a feature
gh issue create --repo SanctionedCodeList/office-bridge --title "Feature: [description]" --body "## Use case\n[Why this is needed]\n\n## Proposed solution\n[How it might work]"

# Check existing issues first
gh issue list --repo SanctionedCodeList/office-bridge

This helps improve the bridge for all users.