iorys/run

IORYS Run script

Maintainers

Details

github.com/iorys-dev/run

Source

Issues

Installs: 65

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Language:Shell

1.0.23 2024-09-10 07:15 UTC

README

Usage

Require package to your project (perhaps as dev-dependency)

composer require iorys/run

Copy run-example.sh to your project root and rename it to run

cp vendor/iorys/run/bin/run-example.sh run

Ensure that run is executable

chmod +x run

If you are using run script in your laravel project, you would like to include laravel_functions.sh to your run script

source vendor/iorys/run/bin/laravel_functions.sh

This will add some useful functions to your run script, like artisan and lara, which are aliases for php artisan.

Once you have your run script ready, you can run your project by executing ./run command

Available functions to use in your run script

addCommand (FUNCTION_NAME, FUNCTION_COMMAND, FUNCTION_DESCRIPTION, FUNCTION_USAGE)
addAlias (FUNCTION_ALIAS_NAME, FUNCTION_BASE_NAME)