 |
VOOZH | about |
|
VOOZH | about |
This document covers the installation process for the hypervel/prompts library, including required PHP version, runtime dependencies, and development dependencies. It provides step-by-step instructions for adding the library to your project and explains the purpose of each dependency.
For information about creating your first prompt after installation, see Quick Start - Your First Prompt. For details about the library architecture and component overview, see Overview.
The hypervel/prompts library requires a modern PHP environment with specific extensions and third-party packages. The following table summarizes all requirements:
| Requirement | Version Constraint | Type | Purpose |
|---|---|---|---|
| PHP | ^8.2 | Runtime | Core language runtime |
| ext-mbstring | * | Runtime | Multibyte string handling for Unicode support |
| composer-runtime-api | ^2.2 | Runtime | Composer plugin API compatibility |
| symfony/console | ^6.2|^7.0 | Runtime | CLI infrastructure and terminal I/O |
| nunomaduro/termwind | ^2.0 | Runtime | HTML-like terminal styling and output rendering |
| hyperf/collection | ~3.1.0 | Development | Collection utilities for testing |
| mockery/mockery | ^1.5 | Development | Mock object framework for unit tests |
Sources: composer.json21-30
Install the library using Composer's require command:
This command adds hypervel/prompts to your project's composer.json and installs all runtime dependencies automatically.
If you are contributing to the library or need to run tests, install with development dependencies:
Alternatively, clone the repository and install dependencies:
Sources: composer.json1-39
The library uses PSR-4 autoloading with an additional helper file that is automatically loaded when the package is included:
Hypervel\Prompts\ maps to the src/ directorysrc/helpers.php is automatically included, providing global helper functionsSources: composer.json13-19
The library requires PHP version 8.2 or higher to leverage modern language features including:
Sources: composer.json22
The mbstring PHP extension is mandatory for proper multibyte string handling. This extension enables the library to:
Without mbstring, the library cannot accurately measure or manipulate strings containing multibyte characters, which would cause display alignment issues.
Sources: composer.json23
Symfony Console provides the CLI infrastructure layer that hypervel/prompts builds upon:
Key Features Used:
Terminal::getWidth(), Terminal::getHeight())The flexible version constraint (^6.2|^7.0) ensures compatibility with both Symfony 6.x and 7.x major versions.
Sources: composer.json25
Termwind enables HTML-like syntax for terminal output styling. The library uses Termwind through the rendering system to produce beautifully formatted CLI output:
Usage in Library:
Sources: composer.json26
This meta-package ensures the project environment uses Composer 2.2 or higher, which provides:
Sources: composer.json24
Development dependencies are only required when contributing to the library or running its test suite.
The Hyperf Collection package provides Laravel-like collection utilities used in test fixtures and examples:
This dependency is scoped to development and does not affect production installations.
Sources: composer.json29
Mockery is a mock object framework used for unit testing:
Used to test prompt components without requiring actual terminal interaction.
Sources: composer.json30
The following diagram shows how dependencies relate to library components:
Sources: composer.json21-30
The library is published under the following configuration:
| Property | Value |
|---|---|
| Package Name | hypervel/prompts |
| Type | library |
| License | MIT |
| Minimum Stability | dev |
| Prefer Stable | true |
| Branch Alias | 0.3-dev (dev-main) |
Keywords: php, hyperf, prompts, swoole, hypervel
The minimum-stability: dev with prefer-stable: true configuration allows development versions while preferring stable releases when available.
Sources: composer.json1-38
After installation, verify the library is correctly installed by checking for the helper functions:
This command displays package information including installed version and dependencies.
To verify autoloading is working, create a test PHP file:
The helper functions should be immediately available without explicit imports due to the files autoload configuration in composer.json17-19
Sources: composer.json13-19
With the library installed, you can now create your first prompt. See Quick Start - Your First Prompt for a tutorial on using the helper functions.
For comprehensive information about all available helper functions, see Helper Functions - The Public API.
To understand how the library renders output and integrates with Termwind, see Theming and Rendering System.
Refresh this wiki