Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 2.66 KB

GETTING_STARTED.md

File metadata and controls

89 lines (62 loc) · 2.66 KB

Getting Started (Local Development)

Run the GitHub Copilot Office Add-in locally using the tray app—no installers required.

📖 See TOOLS_CATALOG.md for a complete list of available Copilot tools for Word, PowerPoint, and Excel.

Prerequisites

Install the following software:

Software Download
Node.js 20+ nodejs.org
Git git-scm.com
Microsoft Office Word, PowerPoint, or Excel (Microsoft 365 or Office 2019+)

Setup

1. Clone and Install Dependencies

git clone https://github.com/patniko/github-copilot-office.git
cd github-copilot-office
npm install

2. Register the Add-in

This trusts the SSL certificate and registers the manifest with Office.

macOS:

./register.sh

Windows (PowerShell as Administrator):

.\register.ps1

3. Start the Tray Application

npm run start:tray

You should see the GitHub Copilot icon appear in your system tray (Windows) or menu bar (macOS).

Adding the Add-in in Office

  1. Confirm you see the GitHub Copilot service running in your macOS or Windows tray.
image
  1. Open Word, PowerPoint, or Excel
  2. image

Close and reopen the app if it was already running before registration

  1. Go to Insert → Add-ins → My Add-ins
image
  1. Look for the GitHub Copilot add-in. Write text or paste images to get started.
image
  1. Have fun!
PowerPoint-spedup.mp4

Troubleshooting

Add-in not showing up?

  • Make sure the tray app is running (check for the icon in your system tray/menu bar)
  • Completely quit and restart the Office application
  • Re-run the register script

SSL Certificate errors?

  • Re-run ./register.sh (macOS) or .\register.ps1 (Windows)
  • On macOS, you may need to enter your password to trust the certificate

Want to use the dev server with hot reload instead?

npm run dev

This starts the development server on port 52390 with hot reload.

Uninstalling

./unregister.sh      # macOS
.\unregister.ps1     # Windows