How to use the command 'choco new' (with examples)

Chocolatey is a package manager for Windows that simplifies the process of managing software by providing a command-line utility. The command choco new is designed to generate new package specification files, making it easier for developers and administrators to create new packages in a standardized format. By using this command, users can quickly set up the foundational files needed to distribute software through Chocolatey. The flexibility of choco new allows for customization through various options, tailoring the package creation process to specific needs.

Use case 1: Create a new package skeleton

Code:

choco new package

Motivation: The need to create a new package skeleton arises when a developer wants to distribute a new software application via Chocolatey. This command will set up the basic structure and necessary files to get started on packaging, reducing the initial setup time and ensuring that the package conforms to Chocolatey’s standards.

Explanation: In this command, new indicates the creation of a new package, whereas package is a placeholder for the package name. This setup will automatically create a folder named after the package and populate it with the basic files, such as the .nuspec file, which describes the package and its dependencies.

Example Output: Upon executing the command, a directory named package is created, containing various files such as package.nuspec, tools/chocolateyInstall.ps1, and tools/chocolateyUninstall.ps1.

Use case 2: Create a new package with a specific version

Code:

choco new package --version version

Motivation: Specifying a version number when creating a new package is crucial for software that undergoes regular updates. Maintaining version control ensures that different versions of the software are available and helps manage compatibility and dependencies.

Explanation: The --version option allows you to designate the specific version number for the package being created. For example, using --version 1.0.0 will set up the package to reflect version 1.0.0, with relevant metadata updated to this version.

Example Output: Executing the command results in a package folder, with the .nuspec file containing <version>1.0.0</version> as part of its metadata.

Use case 3: Create a new package with a specific maintainer name

Code:

choco new package --maintainer maintainer_name

Motivation: Assigning a maintainer to a package is important for accountability and support. The maintainer is responsible for updates, bug fixes, and addressing user issues. This is especially useful in open-source projects or in corporate environments where specific individuals handle different packages.

Explanation: The --maintainer option sets the maintainer’s name in the package metadata, indicating the person or team responsible for the software. This becomes part of the package’s description and can be seen whenever the package information is viewed.

Example Output: After executing this command, the package.nuspec file within the package folder shows <owners>maintainer_name</owners>, reflecting the specified maintainer.

Use case 4: Create a new package in a custom output directory

Code:

choco new package --output-directory path/to/directory

Motivation: Generating the package in a custom directory is useful when organizing projects, allowing you to segregate work environments, keep repositories neat, or accommodate space needs on shared servers.

Explanation: The --output-directory option allows the user to specify a custom path where the package files will be generated. This flexibility helps in managing various projects by directing unnecessary clutter away from the main working directories.

Example Output: The command results in the creation of the package structure at the specified path/to/directory, instead of the default creation location.

Use case 5: Create a new package with specific 32-bit and 64-bit installer URLs

Code:

choco new package url="url" url64="url"

Motivation: Operating systems come in both 32-bit and 64-bit architectures, and providing installers specific to each architecture ensures compatibility and optimization. This option is particularly beneficial for software that has architecture-specific installations.

Explanation: By specifying the url and url64 options, users provide the direct download links for the software’s 32-bit and 64-bit installers, respectively. This information is incorporated into the package’s installation script to fetch the correct installer based on the system architecture during installation.

Example Output: The package created will have URLs embedded in the chocolateyInstall.ps1 script, pointing to the specified 32-bit and 64-bit installers, ensuring that when the software is installed, it pulls the correct version.

Conclusion:

In summary, the choco new command provides a versatile and efficient way to create new Chocolatey packages with a variety of customizable options. Whether you’re just setting up a package structure, controlling versioning, designating maintainers, organizing project directories, or handling architecture-specific installations, choco new streamlines the process, helping developers and system administrators maintain robustness in software distribution.