https://github.com/opencodeco/hfctl
👩💻 Command line interface to help with the creation and maintenance of Hyperf applications in a Docker-based development environment.
https://github.com/opencodeco/hfctl
cli hacktoberfest hyperf script tools
Last synced: 9 months ago
JSON representation
👩💻 Command line interface to help with the creation and maintenance of Hyperf applications in a Docker-based development environment.
- Host: GitHub
- URL: https://github.com/opencodeco/hfctl
- Owner: opencodeco
- License: mit
- Created: 2023-08-05T01:09:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-22T22:58:02.000Z (about 2 years ago)
- Last Synced: 2025-03-27T13:51:35.462Z (10 months ago)
- Topics: cli, hacktoberfest, hyperf, script, tools
- Language: Shell
- Homepage:
- Size: 35.2 KB
- Stars: 18
- Watchers: 27
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# hfctl [](https://github.com/opencodeco/hfctl/actions/workflows/ci.yml)
👩💻 Command line interface to help with the creation and maintenance of Hyperf applications in a Docker-based development environment.
## Getting started
### Installation
Just clone it to your favorite location and run the `install` sub-command:
```shell
git clone https://github.com/opencodeco/hfctl.git ~/.hfctl && ~/.hfctl/hfctl install
```
#### Updates
Then to update, you can just `git pull` or `hfctl self-update`:
```shell
cd ~/.hfctl
git pull
```
## Usage
```shell
hfctl [arguments]
```
### Commands
| Command | Description |
| --- | --- |
| `analyse` | Runs PHPStan analyses |
| `build` | Builds the Hyperf image |
| `composer` | Runs Composer commands |
| `console` | Runs Hyperf console commands (`php bin/hyperf.php `) |
| `coverage` | Runs PHPUnit tests with HTML coverage |
| `create` | Creates a new Hyperf project |
| `down` | Runs Docker Compose down |
| `exec` | Runs a command in the Hyperf container |
| `help` | Shows this help message |
| `init` | Initializes `.hfctl` config file |
| `install` | Installs `hfctl`, `hf` and `hyperf` in your system |
| `lint` | Runs PHP Coding Standards Fixer |
| `logs` | Shows the Hyperf container logs (use `-f` or `--follow` to follow logs) |
| `pre-check` | Checks if the current directory is a Hyperf project |
| `push` | Pushes the Hyperf image to Docker Hub |
| `restart` | Restarts the Hyperf server |
| `self-update` | Updates `hfctl` to the latest version |
| `sh` | Runs a shell in the Hyperf container |
| `sonar` | Runs SonarQube analyses |
| `start` | Starts the Hyperf server (default port is 9501) |
| `stop` | Stops the Hyperf server |
| `test` | Runs PHPUnit tests |
| `up` | Runs Docker Compose up |
| `version` | Displays image tag |
| `watch` | Starts the Hyperf watcher |
## Contributing
Please visit [CONTRIBUTING.md](CONTRIBUTING.md).