hyde/cli

Experimental Standalone Version of HydePHP - The Static Site Generator You've Been Waiting For

v0.10.13 2024-06-25 17:59 UTC

Requires

• php: ^8.1

Requires (Dev)

• hyde/framework: v1.6
• hyde/realtime-compiler: ^3.2
• laravel-zero/framework: ^10.0
• mockery/mockery: ^1.6
• pestphp/pest: ^2.26

Suggests

• ext-curl: Required for using the self-update feature when not installing through Composer.

MIT

• Caen De Silva

• framework
• static site generator
• Hyde
• ssg
• hyde framework
• hydephp
• static site framework
• hydecli

README

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

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)

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.

docker pull ghcr.io/hydephp/cli:latest
docker run --rm -it ghcr.io/hydephp/cli:latest <command>

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:

alias hyde='docker run --rm -it -v $(pwd):/app ghcr.io/hydephp/cli:latest'

Usage

# 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 for more information on what has changed recently.

Contributing

HydePHP is an open-source project, contributions are very welcome! See CONTRIBUTING.md for guidance.

Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker. All vulnerabilities will be promptly addressed.

Credits

• Caen De Silva, feel free to buy me a coffee! https://www.buymeacoffee.com/caen
• All Contributors

License

The MIT License. Please see the License File for more information.