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

The cradle package command is a versatile tool for managing packages within a Cradle instance. Cradle, a PHP framework, allows developers to quickly deploy and manage web applications. This specific command empowers users to handle tasks related to package management, such as listing available packages, installation, updating, and removal. Through these use cases, developers can streamline the process of maintaining up-to-date and organized application components.

Use case 1: Display a list of available packages

Code:

cradle package list

Motivation:

Before installing or updating packages, it’s essential to know which packages are available within the Cradle ecosystem. By listing available packages, you gain insight into the options at your disposal, which makes it easier to plan development or updates effectively. It provides a straightforward way to audit and catalog the packages you may want to explore or utilize.

Explanation:

• cradle: This specifies the Cradle environment where the command will be executed.
• package: Denotes that you are performing an operation related to package tasks.
• list: This argument directs Cradle to display a list of all packages currently available for your instance.

Example output:

Available packages:
- cradlephp/cradle-system
- cradlephp/cradle-activity
- cradlephp/cradle-ui-bootswatch
- cradlephp/cradle-ui-adminlte

Use case 2: Search for a package

Code:

cradle package search package

Motivation:

Searching for a specific package helps when you have a particular piece of functionality in mind and need to find whether it is supported by an existing package. It saves time by letting you directly locate a package by name or keyword instead of manually browsing through an extensive list.

Explanation:

• cradle: The command is executed within the Cradle environment.
• package: Indicates the operation pertains to packages.
• search: Specifies that the operation is to find a package based on a partial or complete name.
• package: This is a placeholder that should be replaced with the actual name or keyword of the package you’re looking for.

Example output:

Searching for 'system':
- cradlephp/cradle-system
- cradlephp/cradle-system-schema

Use case 3: Install a package from Packagist

Code:

cradle package install package

Motivation:

Installing a package is fundamental to expanding the functionality of your Cradle application. Bringing in a new package from Packagist allows you to leverage existing code and avoid reinventing the wheel. This can significantly speed up development and enable you to integrate tried-and-true solutions.

Explanation:

• cradle: Engages the Cradle framework’s command-line tool.
• package: Directs the command towards package management.
• install: Initiates the process of installing a new package.
• package: The identifier for the specific package to be installed. Replace with the desired package name from Packagist.

Example output:

Installing...
Package 'cradlephp/cradle-activity' successfully installed.

Use case 4: Install a specific version of a package

Code:

cradle package install package version

Motivation:

Ensuring compatibility across different parts of a project is critical, and sometimes this means sticking to a specific version of a package. By installing a specified version, you can maintain stability and avoid potential issues caused by unexpected updates or deprecated features.

Explanation:

• cradle: Calls the Cradle environment’s command utility.
• package: Specifies package-related tasks.
• install: Command to install a new package.
• package: Substitute with the name of the package you’re interested in.
• version: Replace with the desired version number, ensuring compatibility with your project’s requirements.

Example output:

Installing version 1.2.3...
Package 'cradlephp/cradle-system' version 1.2.3 installed.

Use case 5: Update a package

Code:

cradle package update package

Motivation:

Regularly updating packages is vital to keep your application secure, efficient, and compatible with the latest standards. By updating packages, you can incorporate enhancements, bug fixes, and security patches, thereby minimizing vulnerabilities and improving functionality.

Explanation:

• cradle: Targets the command to Cradle’s ecosystem.
• package: Instructs the tool to manage package operations.
• update: Commences the process of bringing an installed package to its latest version.
• package: The name of the package you wish to update. Replace with the specific package needing an update.

Example output:

Updating package 'cradlephp/cradle-ui-adminlte'...
Package updated to the latest version 2.4.0.

Use case 6: Update a package to a specific version

Code:

cradle package update package version

Motivation:

When you need certain features or API changes available in specific package versions but not in the latest release, updating to a specified version allows targeted updates that don’t introduce unexpected changes to your codebase. This can help in maintaining application stability while still gaining desired improvements.

Explanation:

• cradle: Activates Cradle’s environment for executing commands.
• package: Designates that package actions are taken.
• update: Command to refresh the package to a given state.
• package: Replace with the name of the package to update.
• version: Set this argument to the version number you want the package to be updated to.

Example output:

Updating package 'cradlephp/cradle-ui-adminlte' to version 2.3.0...
Package updated to version 2.3.0 successfully.

Use case 7: Remove a specific package

Code:

cradle package remove package

Motivation:

As applications evolve, certain packages may become obsolete or unnecessary. Removing these can help streamline your application, improving performance and reducing potential security risks. Package removal is also part of optimizing and cleaning up your Cradle instance.

Explanation:

• cradle: Invokes the Cradle PHP framework’s command tool.
• package: Indicates that the command deals with package handling.
• remove: Triggers the uninstallation of the specified package.
• package: The specific package’s name to be uninstalled; replace it with the exact name of the extraneous package.

Example output:

Removing package 'cradlephp/cradle-ui-bootswatch'...
Package 'cradlephp/cradle-ui-bootswatch' removed successfully.

Conclusion:

The cradle package command is an invaluable resource for managing the packages within a Cradle instance, facilitating various operations from listing and searching to installing, updating, and removing packages. By following these examples, developers can maintain a clean, efficient, and robust application environment—essential for any successful web application project.