# office-addin-manifest

> Read and modify Office Add-in manifest files.

Latest version **3.0.0** (published 2026-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install office-addin-manifest
pnpm add office-addin-manifest
yarn add office-addin-manifest
bun add office-addin-manifest
```

Provides the command `office-addin-manifest`.

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2026-09-09 |
| First published | 2018-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 94.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 194 |
| Author | Office Dev |
| Maintainers | ms-office |
| Keywords | Office, Office Add-in |

## Links

- npm: https://www.npmjs.com/package/office-addin-manifest
- Repository: https://github.com/OfficeDev/Office-Addin-Scripts
- Homepage: https://github.com/OfficeDev/Office-Addin-Scripts#readme
- Issues: https://github.com/OfficeDev/Office-Addin-Scripts/issues
- npm.io page: https://npm.io/package/office-addin-manifest

## Dependencies (9)

- [uuid](https://npm.io/package/uuid.md) ^14.0.1
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [xml2js](https://npm.io/package/xml2js.md) ^0.5.0
- [adm-zip](https://npm.io/package/adm-zip.md) 0.6.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [commander](https://npm.io/package/commander.md) ^13.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [@microsoft/app-manifest](https://npm.io/package/@microsoft/app-manifest.md) ^1.0.2
- [office-addin-usage-data](https://npm.io/package/office-addin-usage-data.md) ^3.0.0

## Recent versions

- 3.0.0 (latest) — 2026-09-09
- 2.1.6 — 2026-07-06
- 2.1.5 — 2026-05-19
- 2.1.4 — 2026-04-24
- 2.1.3 — 2026-04-06
- 2.1.2 — 2025-11-09
- 2.1.1 — 2025-11-04
- 2.1.0 — 2025-05-09
- 2.0.3 — 2025-02-03
- 2.0.2 — 2025-01-16
- 2.0.1 — 2024-12-13
- 2.0.0 — 2024-10-30
- 1.13.6 — 2024-09-27
- 1.13.5 — 2024-09-09
- 1.13.4 — 2024-07-26
- … 111 more at https://npm.io/package/office-addin-manifest/versions

## README

# Office-Addin-Manifest

This package provides the ability to parse, display, modify, and validate the manifest file for Office Add-ins.

For more information, see the [documentation](https://learn.microsoft.com/office/dev/add-ins/develop/add-in-manifests).

## Command-Line Interface

* [info](#info)
* [modify](#modify)
* [validate](#validate)
* [export](#export)

#

### info

Display the information in the Office Add-in manifest.

Syntax:

`office-addin-manifest info <manifest> [options]`

`manifest`: path to manifest file.

#

### modify

Modify values in the Office Add-in manifest file.

Syntax:

`office-addin-manifest modify <manifest> [options]`

`manifest`: path to manifest file.

Options:

`-g [guid]`<br>
`--guid [guid]`

Update the unique ID for the Office Add-in. If the GUID is not provided, a random GUID is used.

This value is the `<Id>` element of `<OfficeApp>`.

For more information, see [OfficeApp documentation](https://learn.microsoft.com/javascript/api/manifest/officeapp).

`-d <name>`<br>
`--displayName <name>`

Update the display name for the Office Add-in.

This value is the `<DisplayName>` element of `<OfficeApp>`.

For more information, see [OfficeApp documentation](https://learn.microsoft.com/javascript/api/manifest/officeapp).

#

### validate

Determines whether the Office Add-in manifest is valid.

Syntax:

`office-addin-manifest validate <manifest>`

`manifest`: path to manifest file.

### export

Packages up the json manifest file and some icons into a zip file.

Syntax:

`office-addin-manifest export [options]`

Options:

`-m <manifest>`<br>
`--manifest <manifest>`

Specify the path to the manifest file. Default is './manifest.json'.

`-o <output>`<br>
`--output <output>`

Specify the path to save the package to. Default is next to the manifest file.

---
_Source: https://npm.io/package/office-addin-manifest · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
