alecrabbit/php-console-spinner
Stars: 238
Forks: 15
Pull Requests: 67
Issues: 5
Watchers: 5
Last Updated: 2023-09-15 14:11:44
Colorful extremely flexible spinner for [async] php cli applications
License: MIT License
Languages: Shell, PHP, Makefile, Dockerfile
Spinner - your task is running
🇺🇦 🏵️ PHP Console Spinner
Old version
0.55.0is available in branch 0.55.x
New version 1.0.0
‼️ documentation is a bit clumsy at the moment- WIP
‼️ API is subject to change until1.0.0-BETA.0- is intended to be used with event loop (see limitations)
Installation
composer require alecrabbit/php-console-spinnerQuick start (asynchronous)
use AlecRabbit\Spinner\Facade;
// ...
$spinner = Facade::createSpinner();
// that's basically it :)Fully working examples can be found in example directory
For more information see Usage
Why?
Main purpose of this library is to provide a simple way to show spinner in console applications (mainly long-running ones). Spinner could be an indicator of running task. For more information see Features and Examples.
alecrabbit/php-console-spinner-extras library provides additional components to extend functionality:
- show progress of running task
- messages of some sort, like status messages
- additional spinners
Features
See Features and limitations for more details
| Feature | |
|---|---|
| Extremely flexible | 🟢️ ️ |
| "Zero" dependencies ️ | 🟢️ * |
| Asynchronous | 🟢️ ️ |
| Synchronous | 🟢️ ️ |
| AutoStart (async) | 🟢️ ️ |
| Signal handling (async) | 🟢️ ️ |
| Cursor auto hide/show | 🟢️ ️ |
"Zero" dependencies
"Zero" dependencies mode means that the library does not require any additional dependencies to work. The only exception
is psr/container. That's why zero is in quotes.
"require": {
"php": ">=8.2",
"psr/container": ">=2.0"
},Links
- Inspired by sindresorhus/cli-spinners