https://github.com/hydephp/cli
Experimental HydePHP Standalone Executable Project
https://github.com/hydephp/cli
Last synced: 9 months ago
JSON representation
Experimental HydePHP Standalone Executable Project
- Host: GitHub
- URL: https://github.com/hydephp/cli
- Owner: hydephp
- License: mit
- Created: 2023-12-01T11:49:17.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-06T22:10:21.000Z (9 months ago)
- Last Synced: 2025-04-10T12:43:05.824Z (9 months ago)
- Language: PHP
- Homepage: https://hydephp.github.io/cli
- Size: 22.4 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Experimental Standalone HydePHP Executable
[](https://packagist.org/packages/hyde/cli)
[](https://github.com/hydephp/cli)
[](https://github.com/hydephp/cli)
[](https://github.com/hydephp/cli/blob/master/LICENSE.md)
[](https://codecov.io/gh/hydephp/cli)
[](https://github.com/hydephp/cli/actions/workflows/tests.yml)
## About
This is an experimental standalone executable for the static site generator HydePHP.
With this global binary, you can use the HydePHP CLI to generate quality static sites faster than ever before!
### ⚠ Beta software notice
Please note that the standalone HydePHP version is **experimental**, and that there may be breaking changes and bugs until the 1.0 release.
- In the meantime, you may want to use the standard HydePHP project: https://github.com/hydephp/hyde
## Installation
### Using Composer 
```bash
composer global require hyde/cli
```
Make sure to place the Composer system-wide vendor bin directory in your `$PATH` so the `hyde` executable can be located by your system. This directory is typically located at `$HOME/.composer/vendor/bin`.
### Direct Download (Unix) 
```bash
curl -L https://github.com/hydephp/cli/releases/latest/download/hyde -o hyde
chmod +x hyde && sudo mv hyde /usr/local/bin/hyde
```
### Docker (Highly Experimental)
> [!WARNING]
> The HydePHP CLI Docker image is under development and is highly experimental. Proceed with caution and report the bugs you will certainly encounter.
```bash
docker pull ghcr.io/hydephp/cli:latest
docker run --rm -it ghcr.io/hydephp/cli:latest
```
Using the Docker image allows you to run the HydePHP CLI without installing any other dependencies like PHP or Composer on your local machine.
If you want to use the HydePHP CLI Docker image as a global command, you can create a shell alias:
```bash
alias hyde='docker run --rm -it -v $(pwd):/app ghcr.io/hydephp/cli:latest'
```
## Usage
```bash
# List available commands
hyde
# Create a new full HydePHP project
hyde new
# Build a site using source files in the working directory
hyde build
```
## Resources
### Changelog
Please see [CHANGELOG](https://github.com/hydephp/cli/blob/master/CHANGELOG.md) for more information on what has changed recently.
### Contributing
HydePHP is an open-source project, contributions are very welcome! See [CONTRIBUTING.md](https://github.com/hydephp/cli/blob/master/CONTRIBUTING.md) for guidance.
### Security
If you discover any security-related issues, please email caen@desilva.se instead of using the issue tracker.
All vulnerabilities will be promptly addressed.
### Credits
- [Caen De Silva](https://github.com/caendesilva), feel free to buy me a coffee! https://www.buymeacoffee.com/caen
- [All Contributors](https://github.com/hydephp/cli/graphs/contributors)
### License
The MIT License. Please see the [License File](https://github.com/hydephp/cli/blob/master/LICENSE.md) for more information.