Macrame is a library for building interactive command line scripts in PHP. It provides methods to create interactive menus, format text for the terminal, handle command-line arguments, read and validate user input, run processes in the background, and more. Macrame was developed as an internal project for Fruitbat Studios/Cloverhitch Technologies/Kludgetastic Implementations.
Macrame is installed via composer:
composer require gbhorwood/macrameFull documentation and a set of examples are found on the documentation site, including:
The fastest way to get up and running is to use the 'hello world' example and replace the 'output text' line with your custom code.
#!/usr/bin/env php
<?php
require __DIR__ . '/vendor/autoload.php';
use Gbhorwood\Macrame\Macrame;
// instantiate a Macrame object with the script name
$macrame = new Macrame("My Script Name");
// only execute if run from the command line
if($macrame->running()) {
// confirm host is good. die on failure.
$macrame->preflight();
// output text to STDOUT
$macrame->text("hello world")->write();
// exit cleanly
$macrame->exit();
}A full walkthrough of 'hello world' is given in the quick start.
Macrame is a pure PHP library. The requirements are:
- PHP 7.4 or higher
posixextensionmbstringextension
Since Macrame is for building command-line applications, it can be difficult to guarantee that the host system meets the minimum requirements. To address this, Macrame provides a preflight() function to validate that the host can run Macrame scripts.
Contributions submitted via pull request are welcome and will be fully credited.
- Use PSR-2 style: Using php-cs-fixer is recommended, but any tool is fine. Do not use windows line endings.
- Use gitflow: Create a new feature branch from
developfor all new feature work. - One pull request per feature/fix: Pull requests should only contain work for one feature or fix.
- Use static analysis (phpstan): All code should pass
phpstanat level 6. Use thephpstan.neonin the repository. - Update documentation if needed: If documentation is required, update the daux pages in the
documentation/directory. - Write tests (phpunit): Achieving 100% coverage is difficult, especially for anything that uses animations or forks child processes, but please try.