Skip to main content

Funding (FUNDING.yml)

Create a .github/FUNDING.yml populated with sponsor and funding links from the Nova config.

Why Use This Command?

  • Centralizes sponsor and donation links in a single config-driven file.
  • Enables the Sponsor button on your GitHub repository automatically.
  • Keeps funding sources consistent across projects managed by Nova.

Requirements

  • Node.js runtime — Use any Node.js LTS release.
  • Project root — Run the command from the directory containing the top-level package.json.
  • nova.config.json — A valid config file must exist at the project root with the fields listed below.

Usage

Options

FlagDescription
-d, --dry-runPreview the target file path without writing anything to disk.
-r, --replace-fileOverwrite the existing file instead of creating a .nova-backup copy.

Config Fields

FieldDescription
urls.fundSourcesArray of sponsor and donation URLs used to populate FUNDING.yml.

Output Files

FileDescription
.github/FUNDING.ymlGitHub sponsor and donation links.