Skip to content

command-sponsors

sponsors¤

Manage sponsors.

list¤

List sponsors.

List sponsors and non-sponsors benefitting from sponsorships.

Options Description Default
--ghsa, --github-sponsored-account GITHUB_SPONSORED_ACCOUNT The sponsored account on GitHub Sponsors. sponsors.github-sponsored-account config-value or none
--ghiu, --github-include-users INCLUDE_USERS Users that should always be in the team. sponsors.include-users config-value
--gheu, --github-exclude-users EXCLUDE_USERS Users that should never be in the team. sponsors.exclude-users config-value
--ghb, --github-beneficiaries GITHUB_BENEFICIARIES Beneficiaries of GitHub sponsors. sponsors.github-beneficiaries config-value
--ght, --github-token GITHUB_TOKEN A GitHub token. Recommended scopes: admin:org and read:user. GITHUB_TOKEN env-var or sponsors.github-token-command config-value
--plsa, --polar-sponsored-account POLAR_SPONSORED_ACCOUNT The sponsored account on Polar. sponsors.polar-sponsored-account config-value or none
--plb, --polar-beneficiaries POLAR_BENEFICIARIES Beneficiaries of Polar sponsors. sponsors.polar-beneficiaries config-value
--plt, --polar-token POLAR_TOKEN A Polar token. Recommended scopes: user:read, issues:read, subscriptions:read. POLAR_TOKEN env-var or sponsors.polar-token-command config-value
-m, --minimum-amount MINIMUM_AMOUNT Minimum amount to be considered an insider. sponsors.minimum-amount config-value or 0
--public Only use public sponsorships.
-S, --sponsorships List sponsorships rather than users/sponsors.

show¤

Show details about a sponsor/user.

TODO. Show details about a sponsor/user.

Arguments Description Default
INSIDERS_TEAM The GitHub team to sync. sponsors.insiders-team config-value
Options Description Default
--ghsa, --github-sponsored-account GITHUB_SPONSORED_ACCOUNT The sponsored account on GitHub Sponsors. sponsors.github-sponsored-account config-value or none
--iu, --include-users INCLUDE_USERS Users that should always be in the team. sponsors.include-users config-value
--eu, --exclude-users EXCLUDE_USERS Users that should never be in the team. sponsors.exclude-users config-value
--ghb, --github-beneficiaries GITHUB_BENEFICIARIES A mapping of users belonging to sponsoring organizations. sponsors.github-beneficiaries config-value
--ght, --github-token GITHUB_TOKEN A GitHub token. Recommended scopes: admin:org and read:user. GITHUB_TOKEN env-var or sponsors.github-token-command config-value
--plsa, --polar-sponsored-account POLAR_SPONSORED_ACCOUNT The sponsored account on Polar. sponsors.polar-sponsored-account config-value or none
--plt, --polar-token POLAR_TOKEN A Polar token. Recommended scopes: user:read, issues:read, subscriptions:read. POLAR_TOKEN env-var or sponsors.polar-token-command config-value
-m, --minimum-amount MINIMUM_AMOUNT Minimum amount to be considered an insider. sponsors.minimum-amount config-value or 0
--dry-run Display the changes that would be made, without making them. False

team-list¤

List members of a team.

List the members of a GitHub team.

team-sync¤

Synchronize members of a team with current sponsors.

Fetch current sponsors from GitHub, then grant or revoke access to a GitHub team for eligible sponsors.

Arguments Description Default
INSIDERS_TEAM The GitHub team to sync. sponsors.insiders-team config-value
Options Description Default
--ghsa, --github-sponsored-account GITHUB_SPONSORED_ACCOUNT The sponsored account on GitHub Sponsors. sponsors.github-sponsored-account config-value or none
--iu, --include-users INCLUDE_USERS Users that should always be in the team. sponsors.include-users config-value
--eu, --exclude-users EXCLUDE_USERS Users that should never be in the team. sponsors.exclude-users config-value
--ghb, --github-beneficiaries GITHUB_BENEFICIARIES A mapping of users belonging to sponsoring organizations. sponsors.github-beneficiaries config-value
--ght, --github-token GITHUB_TOKEN A GitHub token. Recommended scopes: admin:org and read:user. GITHUB_TOKEN env-var or sponsors.github-token-command config-value
--plsa, --polar-sponsored-account POLAR_SPONSORED_ACCOUNT The sponsored account on Polar. sponsors.polar-sponsored-account config-value or none
--plb, --polar-beneficiaries POLAR_BENEFICIARIES Beneficiaries of Polar sponsors. sponsors.polar-beneficiaries config-value
--plt, --polar-token POLAR_TOKEN A Polar token. Recommended scopes: user:read, issues:read, subscriptions:read. POLAR_TOKEN env-var or sponsors.polar-token-command config-value
-m, --minimum-amount MINIMUM_AMOUNT Minimum amount to be considered an insider. sponsors.minimum-amount config-value or 0
--dry-run Display the changes that would be made, without making them. False