Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jolicode/castor
đĻĢ DX oriented task runner and command launcher built with PHP.
https://github.com/jolicode/castor
cli command-line command-line-tool hacktoberfest php-library task-runner tool
Last synced: about 2 months ago
JSON representation
đĻĢ DX oriented task runner and command launcher built with PHP.
- Host: GitHub
- URL: https://github.com/jolicode/castor
- Owner: jolicode
- License: mit
- Created: 2023-05-17T15:08:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-14T12:43:35.000Z (5 months ago)
- Last Synced: 2024-04-14T14:53:11.292Z (5 months ago)
- Topics: cli, command-line, command-line-tool, hacktoberfest, php-library, task-runner, tool
- Language: PHP
- Homepage: https://castor.jolicode.com
- Size: 7.17 MB
- Stars: 347
- Watchers: 15
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Castor is a DX oriented task
runner built in PHP featuring a range of functions for common task processing.
It can be viewed as an alternative to Makefile, Fabric, Invoke, Shell scripts,
etc., but it leverages PHP's scripting capabilities and its extensive library ecosystem.
It comes with many features to make your life easier:
* Seamless parsing of **arguments and options**, simplifying input handling
* **[Autocomplete](https://castor.jolicode.com/going-further/interacting-with-castor/autocomplete)** support for faster and error-free typing
* A built-in list of useful functions:
* [`run()`](https://castor.jolicode.com/getting-started/run/#the-run-function): Runs external processes, enabling seamless integration with external tools
* [`io()`](https://castor.jolicode.com/going-further/helpers/console-and-io/#the-io-function): Displays beautiful output and interacts with the terminal
* [`watch()`](https://castor.jolicode.com/going-further/helpers/watch/): Watches files and automatically triggers actions on file modifications
* [`fs()`](https://castor.jolicode.com/going-further/helpers/filesystem/#the-fs-function): Creates, removes, and manipulates files and directories
* [And even more advanced functions](https://castor.jolicode.com/reference/)
> [!NOTE]
> Castor is still in early development, and the API is not stable yet. Even if
> it is unlikely, it is still possible that it will change in the
> future.
## Usage
In Castor, tasks are set up as typical PHP functions marked with the `#[AsTask()]` attribute in a `castor.php` file.
These tasks can run any PHP code but also make use of various [functions for standard operations](https://castor.jolicode.com/reference/) that come pre-packaged with Castor.
For example:
```php
writeln('Hello from castor');
}
```
Will expose a `greetings:hello` task that you can run with `castor greetings:hello`:
```bash
$ castor greetings:hello
Hello from castor
```
Then, you can go wild and create more complex tasks:
```php
#[AsTask(description: 'Clean the infrastructure (remove container, volume, networks)')]
function destroy(bool $force = false)
{
if (!$force) {
io()->warning('This will permanently remove all containers, volumes, networks... created for this project.');
io()->comment('You can use the --force option to avoid this confirmation.');
if (!io()->confirm('Are you sure?', false)) {
io()->comment('Aborted.');
return;
}
}
run('docker-compose down -v --remove-orphans --volumes --rmi=local');
notify('The infrastructure has been destroyed.')
}
```
If you want to read more about usage, you can read the
[basic usage](https://castor.jolicode.com/getting-started/) documentation, or
watch [some examples](https://castor.jolicode.com/examples/).
## Installation
### With the installer
> [!TIP]
> This is the recommended way to install Castor on Linux and macOS. It requires PHP >= 8.1.
```bash
curl "https://castor.jolicode.com/install" | bash
```
There are other ways to install Castor, please refer to the
[documentation](https://castor.jolicode.com/getting-started/installation/).
## Further documentation
Discover more by reading the docs:
* [Getting started with Castor](https://castor.jolicode.com/getting-started/)
* [Installation and Autocomplete](https://castor.jolicode.com/getting-started/installation/)
* [Basic Usage](https://castor.jolicode.com/getting-started/basic-usage/)
* [Executing Processes with `run()`](https://castor.jolicode.com/getting-started/run/)
* [Task Arguments](https://castor.jolicode.com/getting-started/arguments)
* [Using the Context](https://castor.jolicode.com/getting-started/context)
* [Going further with Castor](https://castor.jolicode.com/going-further/)
* [Castor reference](https://castor.jolicode.com/reference/)
* [Examples](https://castor.jolicode.com/examples/)
* [Frequently asked questions](https://castor.jolicode.com/faq/)