@modern-office/sideload
v0.1.0
Published
Provides start, sideload, and unsideload for generated projects, including app packaging, registration, host launch, and the in-process Vite dev server.
Maintainers
Readme
@modern-office/sideload
This package registers generated projects that use either a unified JSON manifest or add-in-only XML manifests, then launches desktop Office during development.
Unified manifests and Outlook XML manifests require a work or school account whose tenant allows custom app upload. Task-pane XML manifests do not require sign-in.
atk auth login m365Commands
| Command | Effect |
| --- | --- |
| modern-office start [--host <host>] [--manifest <path>]... | Starts Vite, registers when needed, and launches Office. Repeat --manifest for several files. |
| modern-office sideload [--host <host>] [--manifest <path>]... | Registers when needed, launches Office, and exits. Repeat --manifest for several files. |
| modern-office unsideload [--title-id <id>] | Uninstalls the add-in and clears local state. |
| modern-office clear-cache | Removes only this add-in's Office cache entries; close Office first. It never touches other add-ins or the WebView2 profile. |
| modern-office package [--dist <dir>] [--out <file>] | Prepares the production build for upload. |
Office picks up a newly registered add-in when the launch document opens, but
an instance that already loaded an earlier version keeps it until it restarts;
start warns when that happens. After a re-registration or unsideload, the
tool removes only this add-in's cache entries, matched by manifest id, and
only while Office is closed. It never touches other add-ins or the WebView2
profile.
Agents Toolkit resolution
The package resolves atk in this order:
- The project's
node_modules/.bin/atk. - A global
atkonPATH. npx --yes -p @microsoft/m365agentstoolkit-cli atk.
See Sideloading for registration, state, packaging, and host-launch details.
License
MIT
