https://github.com/dvnc0/clyde
A PHP CLI Application builder
https://github.com/dvnc0/clyde
cli php-cli-framework php8
Last synced: 19 days ago
JSON representation
A PHP CLI Application builder
- Host: GitHub
- URL: https://github.com/dvnc0/clyde
- Owner: dvnc0
- Created: 2023-08-06T06:03:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T05:23:20.000Z (almost 2 years ago)
- Last Synced: 2026-01-02T12:37:45.938Z (4 months ago)
- Topics: cli, php-cli-framework, php8
- Language: PHP
- Homepage: https://github.com/dvnc0/clyde/wiki
- Size: 89.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Clyde
Your friendly neighborhood CLI framework.
[](https://github.com/dvnc0/clyde/actions/workflows/php.yml)
[](https://github.com/dvnc0/clyde/actions/workflows/stan.yml)
**Documentation is incomplete**
[Wiki](https://github.com/dvnc0/clyde/wiki)
**This is still a WIP**
## Purpose
A small framework that tries to stay out of the way and help you rapidly build command line applications.
## The most basic app
The flexibility of the framework allows you to build applications in a number of ways, the simplest method is shown below.
```php
about('A small developer tool to help do some cool things')
->version('1.0.0')
->author('dvnc0')
->website('https://github.com/dvnc0')
->command(
Command::create('encode ')
->about('Encode the passed string with base64')
->action(function($args) {
print(base64_encode($args['string']));
exit(0);
})
->save()
)
->run();
```
This will create the help pages, routes, and process the command using `php devtool encode "Hello World"`.
### It's flexible
The Application expects that the method `Command` will return a `Command_Object` this patter follows for Commands and Args as well. This allows you to abstract away the creation of Commands and Args to additional classes if needed. As long as the commands return a valid `Command_Object` everything will be fine. Essentially, the Application is a collection of Objects.
## Commands
Command actions should extend `Clyde\Actions\Action_Base` or be a callable function. Callable functions will be given an array of arguments and classes extending `Action_Base` are given a Request object.
The command `version` is automatically added as well as the `help` command. Commands also automatically get the `--help` argument which displays their help information.
## Tasks and Task Runner
Commands can run tasks that extend `Clyde\Tasks\Task_Base` via the Task_Runner. This will fork the task into a new process and add a CLI progress spinner while the task executes.
## Helpers
The project also includes some helper classes for printing tables, interactive user prompts, styled printing, and adding Emojis.