Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decodelabs/effigy
Universal CLI entry point
https://github.com/decodelabs/effigy
Last synced: 1 day ago
JSON representation
Universal CLI entry point
- Host: GitHub
- URL: https://github.com/decodelabs/effigy
- Owner: decodelabs
- License: mit
- Created: 2022-11-07T08:36:17.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-06T11:19:01.000Z (2 months ago)
- Last Synced: 2024-12-06T14:49:29.180Z (about 1 month ago)
- Language: PHP
- Size: 187 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Effigy
[](https://packagist.org/packages/decodelabs/effigy)
[](https://packagist.org/packages/decodelabs/effigy)
[](https://packagist.org/packages/decodelabs/effigy)
[](https://github.com/decodelabs/effigy/actions/workflows/integrate.yml)
[](https://github.com/phpstan/phpstan)
[](https://packagist.org/packages/decodelabs/effigy)
### Universal CLI entry point
Effigy is a globally installed universal CLI tool for easily running tasks in your application.
_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._
---
## Installation
```bash
composer global require decodelabs/effigy
```
You will also need to have added your global composer installation bin directory to your $PATH in your ~/.bash_profile or ~/.bashrc file:
```bash
export PATH=~/.config/composer/vendor/bin:$PATH
```
_Note, earlier versions of composer may store global config in `~/.composer/vendor/bin` - adapt your $PATH as necessary. You can find composer's home path with `composer global config home`_
## Usage
Effigy can be used to simplify running tasks in your project from the command line. Its primary job is to locate and load the main entry point to your project via a globally installed executable.
Say for example, you currently run commands in your project though `webroot/index.php` as your primary entry point:
```bash
php webroot/index.php run-task
```
Define your entry point in your composer.json file:
```json
{
"extra": {
"effigy": {
"entry": "webroot/index.php"
}
}
}
```
Then you can run CLI commands available in your project via the `effigy` executable directly:
```bash
effigy run-task
```
Should you need per-environment entry files, specify template keys in your composer config:
```json
{
"extra": {
"effigy": {
"entry": "entry/{{env}}.php"
}
}
}
```
Then on first run, Effigy will ask for the "env" parameter and save it in a local config file (which gets added to your .gitignore).
### Local installation
If you don't want to install Effigy globally, you can use it as a local executable in your project.
```bash
composer require decodelabs/effigy
vendor/bin/effigy install-local
```
You can then call effigy like so:
```bash
./effigy run-task
```
### PHP binary
Effigy can use alternative versions of PHP on a per-project basis:
```bash
effigy set-php
> php8.1
```
The bin path is stored in your local config and all process launches will use this going forward. Reset it to "php" to use the default system global binary.
### Composer passthrough
Effigy will attempt to run scripts defined in your composer.json:
```json
{
"scripts": {
"analyze": "phpstan analyze"
}
}
```
```bash
effigy analyze
```
You can also run composer commands through effigy directly:
```bash
effigy composer require decodelabs/atlas
```
This is especially useful if you have defined an alternative version of PHP for your project as global composer will use global PHP.
## Licensing
Effigy is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.