89 lines
1.8 KiB
Markdown
89 lines
1.8 KiB
Markdown
|
# 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.
|