How to use the command 'cradle package' (with examples)

The cradle package command is used to manage packages for a Cradle instance. It allows users to display a list of available packages, search for packages, install packages, update packages, and remove packages. This article will illustrate each of these use cases with examples.

Use case 1: Display a list of available packages

Code:

cradle package list

Motivation: This use case allows users to see a list of all available packages for a Cradle instance. It can be helpful when trying to determine which packages are already installed or to discover new packages to install.

Explanation:

• cradle package - invokes the package command in the Cradle CLI.
• list - the action argument, specifies that the command should list available packages.

Example output:

Available packages:
- package1
- package2
- package3
...

Use case 2: Search for a package

Code:

cradle package search package

Motivation: This use case allows users to search for a specific package by name. It can be useful when trying to find a specific package to install or to check if a package exists.

Explanation:

• cradle package - invokes the package command in the Cradle CLI.
• search package - the action argument, specifies that the command should search for a package named “package”.

Example output:

Matching packages:
- package1
- package2
...

Use case 3: Install a package from Packagist

Code:

cradle package install package

Motivation: This use case allows users to install a package from Packagist. Packagist is the default package repository for Cradle and is a great source of open-source packages.

Explanation:

• cradle package - invokes the package command in the Cradle CLI.
• install package - the action argument, specifies that the command should install a package named “package” from Packagist.

Example output:

Installing package package...
Package package has been installed successfully.

Use case 4: Install a specific version of a package

Code:

cradle package install package version

Motivation: This use case allows users to install a specific version of a package from Packagist. It can be useful when working with packages that have different versions and you need to install a specific version.

Explanation:

• cradle package - invokes the package command in the Cradle CLI.
• install package version - the action argument, specifies that the command should install a specific version of a package named “package” from Packagist.

Example output:

Installing package package version...
Package package (version) has been installed successfully.

Use case 5: Update a package

Code:

cradle package update package

Motivation: This use case allows users to update a package to the latest version. It can be helpful when a newer version of a package is released and you want to make use of the latest features and bug fixes.

Explanation:

• cradle package - invokes the package command in the Cradle CLI.
• update package - the action argument, specifies that the command should update a package named “package” to the latest version.

Example output:

Updating package package...
Package package has been updated successfully.

Use case 6: Update a package to a specific version

Code:

cradle package update package version

Motivation: This use case allows users to update a package to a specific version. It can be useful when you want to update a package to a specific version rather than the latest version.

Explanation:

• cradle package - invokes the package command in the Cradle CLI.
• update package version - the action argument, specifies that the command should update a package named “package” to a specific version.

Example output:

Updating package package to version...
Package package (version) has been updated successfully.

Use case 7: Remove a specific package

Code:

cradle package remove package

Motivation: This use case allows users to remove a specific package. It can be helpful when a package is no longer needed or when troubleshooting issues related to a specific package.

Explanation:

• cradle package - invokes the package command in the Cradle CLI.
• remove package - the action argument, specifies that the command should remove a package named “package”.

Example output:

Removing package package...
Package package has been removed successfully.

Conclusion:

The cradle package command provides a convenient way to manage packages for a Cradle instance. Users can list available packages, search for packages, install, update, and remove packages using this command. By understanding the different use cases and their associated commands, users can effectively manage packages for their Cradle projects.