Skip to content

New-SPDXLicense

SYNOPSIS

Creates a new licence using the SPDX format

SYNTAX

New-SPDXLicense [-LicenseType] <String> [-Owner] <String> [[-Year] <Int32>]
 [<CommonParameters>]

DESCRIPTION

This cmdlet will create a new licence file using the SPDX format. This is a standardised format for licences that can be used in a variety of projects. Currently only the MIT licence is supported.

EXAMPLES

Example 1

New-SPDXLicense -LicenseType 'MIT' -Owner 'Brownserve'

This would return the MIT licence with the copyright holder set to Brownserve.

PARAMETERS

-LicenseType

The type of licence to create. (Currently only MIT is supported)

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: MIT

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Owner

The owner of the licence, this is used to populate the copyright holder in the licence.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Year

The year to use in the licence, if not specified the current year will be used.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES