https://github.com/charcoalphp/conductor
https://github.com/charcoalphp/conductor
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/charcoalphp/conductor
- Owner: charcoalphp
- Created: 2024-02-15T16:43:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T10:05:20.000Z (almost 2 years ago)
- Last Synced: 2025-07-15T00:00:12.313Z (12 months ago)
- Language: PHP
- Size: 104 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Charcoal Conductor
A CLI tool for interacting with the [Charcoal framework](https://github.com/charcoalphp/charcoal).
## Requirements
- php ^7.4
- composer
## Installation
```BASH
composer global config repositories.stecman/symfony-console-completion vcs https://github.com/MouseEatsCat/symfony-console-completion
composer global require charcoal/conductor
```
### Autocompletion
To enable autocompletion, you need to add the following to your `.bashrc` or `.zshrc` file.
```BASH
source <(conductor _completion -g -p conductor)
```
## Commands
| Command | Description |
| ------------------ | ------------------------------------------------------------- |
| help | Display help for a command |
| list | List commands |
| models:create | Create a new Model |
| models:list | List all registered Models |
| models:sync | Synchronize the database with model definitions |
| attachments:create | Create a new Attachment |
| attachments:list | List all registered Attachments |
| attachments:sync | Synchronize the attachments table with attachment definitions |
| scripts:list | List all charcoal scripts |
| scripts:run | Run a charcoal script |
| project:create | Create a new charcoal project |