Skip to content

API Reference ​

This section provides detailed documentation for all plugin options and APIs.

Quick Reference ​

OptionTypeDescription
contentstringBanner content with template variables
filestringPath to banner file
varsobjectCustom template variables
includestring | string[]Files to include
excludestring | string[]Files to exclude
bannersobjectMultiple banners by file type
envVarstringEnvironment variable name
envValuestringExpected env var value
pkgPathstringCustom package.json path

Template Variables ​

Available in content and banners:

VariableDescription
${name}Package name
${version}Package version
${author}Package author
${license}Package license

Sections ​

  • Options - Detailed options documentation
  • Plugin API - Exposed plugin properties and methods

Released under the MIT License.