This is part of the Fake.Windows.Chocolatey module.

ChocoPackParams

The choco pack parameter type.

Record Fields

Record FieldDescription
AdditionalArgs
Signature: string

A character string containing additional arguments to give to choco.

Authors
Signature: string list

Authors of the package. Used for the nuspec creation.

BugTrackerUrl
Signature: string

Url pointing to the location where issues and tickets can be accessed. Used for the nuspec creation.

Checksum
Signature: string

The checksum hash value of the PackageDownloadUrl resource This allows a checksum to be validated for files that are not local. The checksum type is covered by ChecksumType. Equivalent to the --checksum <string> option of Install-ChocolateyZipPackage functions. Used to create chocolateyInstall.ps1 if it doesn't exists.

Checksum64
Signature: string

The checksum hash value of the PackageDownload64Url resource This allows a checksum to be validated for files that are not local. The checksum type is covered by ChecksumType64. Equivalent to the --checksum <string> option of Install-ChocolateyZipPackage functions. Used to create chocolateyInstall.ps1 if it doesn't exists.

Checksum64Type
Signature: ChocolateyChecksumType

The type of checksum that the file is validated with. Default: Sha256 Used to create chocolateyInstall.ps1 if it doesn't exists.

ChecksumType
Signature: ChocolateyChecksumType

The type of checksum that the file is validated with. Default: Sha256 Used to create chocolateyInstall.ps1 if it doesn't exists.

Copyright
Signature: string

Copyright of the package. Used for the nuspec creation.

Dependencies
Signature: NugetDependencies

Dependencies of the package. Used for the nuspec creation.

DependenciesByFramework
Signature: NugetFrameworkDependencies list

Dependencies by framework of the package. Used for the nuspec creation.

Description
Signature: string

Description of the package. Used for the nuspec creation.

DevelopmentDependency
Signature: bool

Boolean specifying whether the package will be marked as a development-only dependency. Default: false. Used for the nuspec creation.

DocsUrl
Signature: string

Url pointing to the location of the wiki or docs of the software. Used for the nuspec creation.

Files
Signature: (string * string option * string option) list

Files of the package. Used for the nuspec creation.

FrameworkAssemblies
Signature: NugetFrameworkAssemblyReferences list

Framework assemblies of the package. Used for the nuspec creation.

IconUrl
Signature: string

Url to the icon of the package. Used for the nuspec creation.

InstallerType
Signature: ChocolateyInstallerType

Installer type. Default: Zip. Used to create chocolateyInstall.ps1 and/or chocolateyUninstall.ps1 if it doesn't exists.

LicenseUrl
Signature: string

Url to the license of the software. Used for the nuspec creation.

MailingListUrl
Signature: string

Url pointing to the forum or email list group for the software. Used for the nuspec creation.

NonInteractive
Signature: bool

Do not prompt for user input or confirmations. Default true. Equivalent to the -y option.

OutputDir
Signature: string

Output directory for the files (nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1) creation.

Owners
Signature: string list

Owners of the package. Used for the nuspec creation.

PackageDownload64Url
Signature: string

Url pointing to the installer (exe, msi, zip) of the 64 bits version of the package. Used to create chocolateyInstall.ps1 if it doesn't exists.

PackageDownloadUrl
Signature: string

Url pointing to the installer (exe, msi, zip) of the package. Used to create chocolateyInstall.ps1 if it doesn't exists.

PackageId
Signature: string

Id of the package. Should be lowercase, not contains weird chars and use dash (-) instead of spaces. Used for the nuspec creation.

PackageSourceUrl
Signature: string

Url to the chocolatey package repository, not the software (unless they are the same). Used for the nuspec creation.

ProjectSourceUrl
Signature: string

Url pointing to the location of the underlying software source. Used for the nuspec creation.

ProjectUrl
Signature: string

Url to the software. Used for the nuspec creation.

References
Signature: NugetReferences

References of the package. Used for the nuspec creation.

ReferencesByFramework
Signature: NugetFrameworkReferences list

References by framework of the package. Used for the nuspec creation.

ReleaseNotes
Signature: string

Release notes of the package. Used for the nuspec creation.

RequireLicenseAcceptance
Signature: bool

True if the software needs license acceptance. Default: false. Used for the nuspec creation.

SilentArgs
Signature: string

Silent args for the installer. Used to create chocolateyInstall.ps1 and/or chocolateyUninstall.ps1 if it doesn't exists.

Summary
Signature: string

Summary of the package. Used for the nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1 creation.

Tags
Signature: string list

Tags of the package. Used for the nuspec creation.

Timeout
Signature: TimeSpan

The choco execution timeout.

Title
Signature: string

Title of the package. Used for the nuspec creation.

ToolPath
Signature: string

The location of the choco executable. Automatically found if null or empty.

UninstallPath
Signature: string

Either:

  • For zip: the zip filename originally installed
  • For exe or msi: the full path to the native uninstaller to run
UnzipLocation
Signature: string

Unzip location for zip package. Default: Chocolatey install folder. Used to create chocolateyInstall.ps1 if it doesn't exists.

Version
Signature: string

The version you would like to insert into the package. Equivalent to the --version <version> option.