How to Use the Command 'cradle install' (with examples)

The cradle install command is integral to setting up the Cradle PHP framework, a powerful platform for building custom PHP applications. By executing this command, users can effortlessly install various components of the framework, including configurations, libraries, and tools required for a functional Cradle environment. This command can also be fine-tuned with additional options to cater to specific installation needs, making it a versatile tool for developers.

Install Cradle’s Components

Code:

cradle install

Motivation: Using the basic cradle install command is an essential first step when setting up the Cradle environment. This command simplifies the setup process by automatically installing the necessary components, libraries, and configurations required to get started with Cradle development. It is designed to prompt users for additional details, ensuring that the installation is customized according to their needs.

Explanation: The absence of additional flags in this command indicates a standard installation procedure. By executing it, users will be provided with prompts where they must input necessary details, such as database configurations or optional component choices, ensuring that the installation is tailored specifically to their project’s requirements.

Example Output:

Welcome to Cradle PHP Framework Installer
Please enter your database host: 
Please enter your database username: 
...
Installation Complete

Use Case: Forcefully Overwrite Files

Code:

cradle install --force

Motivation: Occasionally, it might be necessary to overwrite existing files during the installation process—especially when upgrading components or resetting the environment. The --force option provides a convenient way to ensure that all files are replaced regardless of existing versions or states, which can be particularly useful in development environments where changes are frequent.

Explanation: The --force flag instructs the installer to disregard existing files and overwrite them without prompting for confirmation. This approach is efficient when the user is fully aware that existing setups need to be overridden to apply new changes or updates effectively.

Example Output:

Installing components...
Overwriting existing files...
Installation Complete. All files were replaced.

Use Case: Skip Running SQL Migrations

Code:

cradle install --skip-sql

Motivation: In environments where database migrations are managed separately or where migrations have already been applied, skipping them during the installation can save time and avoid redundant operations. The --skip-sql option makes it easy to bypass this step when it is unnecessary.

Explanation: The --skip-sql flag tells the installer not to execute any SQL migrations that might typically be part of the installation routine. This can be beneficial when the database is pre-configured or when migrations are intended to be executed manually later.

Example Output:

Installing components...
Skipping SQL migrations...
Installation Complete. Database migrations were not run.

Use Case: Skip Running Package Updates

Code:

cradle install --skip-versioning

Motivation: When there’s a need to install Cradle components without updating existing packages, such as in a stable production environment where updates are systematically controlled, the --skip-versioning option becomes useful. It helps maintain the current state without incorporating any new updates that might affect existing setups.

Explanation: The --skip-versioning flag prevents the command from checking for or applying newer versions of the packages during the installation process. This can help maintain consistency in environments where updates are managed separately from the installation.

Example Output:

Installing components...
Skipping package updates...
Installation Complete. No packages were updated.

Use Case: Use Specific Database Details

Code:

cradle install -h hostname -u username -p password

Motivation: The need to specify database connection details during installation is critical for environments where the default interactive prompt approach is insufficient or where automated setups are preferred. This could be especially true in scripting scenarios or continuous integration pipelines where human interaction is limited.

Explanation:

• -h hostname: Specifies the database host. This allows the installer to connect to the correct database server.
• -u username: Provides the username necessary for authentication against the database.
• -p password: Accompanies the username to establish a secure database connection by providing the requisite password.

These options collectively ensure that the installation happens precisely with the database instance intended, avoiding misconfigurations that could stem from manual errors.

Example Output:

Installing components...
Connecting to database on hostname...
Installation Complete. Database configured successfully.

Conclusion:

The cradle install command, with its diverse range of options, offers flexibility and control over how the Cradle PHP framework is set up. These examples demonstrate how its functionality can be expanded to fit various installation scenarios—from standard setups to environments requiring explicit configurations for files and databases. By understanding each use case, developers can effectively tailor their Cradle installations to match their project’s specific needs, ensuring setup consistency and operational efficiency.