wire-cli is a CLI (Command-Line Interface) tool designed to provide ease of use and efficiency for ProcessWire developers. With wire-cli, you can automate common tasks, manage ProcessWire projects effortlessly, and enhance your development workflow.
- Create new ProcessWire projects
- Serve ProcessWire via built-in PHP webserver
- Perform database backup and restoration
- Manage fields, templates, roles, users, and modules
- Generate boilerplate modules
- Check for core upgrades
- And more...
wire-cli is based on the defunct wireshell, built using the Symfony Console Component, offering a powerful and intuitive command-line interface for interacting with ProcessWire projects and adding new commands. It is compatible with PHP 8.1.
Please note that wire-cli and another tool called rockshell share similar goals and functionality. In the future, the features of wire-cli and rockshell will be merged to provide a unified and comprehensive CLI tool for ProcessWire developers.
To install wire-cli, you need to have Composer installed. Run the following command to install wire-cli globally:
composer global require wirecli/wire-cli
Run wire-cli followed by the desired command to execute various tasks. For example:
wire-cli new myproject
- You can use both relative and absolute paths for arguments like
--src. - Paths with spaces should be quoted:
--src="C:/path/with spaces/ProcessWire" - Both forward
/and backward\slashes are supported; they are normalized automatically. - If the path does not exist or is not accessible, a clear error message will be shown.
For a complete list of available commands and options, use the help command:
For detailed documentation and usage examples, please refer to the official documentation.
Support thread: https://processwire.com/talk/topic/28788-wire-cli-a-cli-tool-for-processwire-developers/
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please submit an issue or a pull request on the GitHub repository.
As always, thanks to all the contributors!
j. eizmendi
wire-cli is inspired by the work of the following authors of the initial developers/contributors of wireshell:
- Marcus Herrmann
- Hari K T
- Bea David
- Camilo Castro
- Horst Nogajski
This project is licensed under the MIT License.