wirecli / wire-cli

🌀 An extendable CLI tool for ProcessWire developers. Automate common tasks and manage your ProcessWire projects effortlessly.

wire-cli

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.

Features

• 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.

Installation

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

Usage

Run wire-cli followed by the desired command to execute various tasks. For example:

wire-cli new myproject

For a complete list of available commands and options, use the help command:

Documentation

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/

Contributing

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.

Contributors

As always, thanks to all the contributors!

Available commands

Credits

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

License

This project is licensed under the MIT License.

wire-cli's Issues

Setting site/config.php with wire-cli

Hello, @flydev-fr!

I found some problems with installing ProcessWire via wire-cli.

I think that the following should be added to the site/config.php file:

1. $config->tableSalt (salt);
2. $config->installed (installation date).

Can you please add it?

Upgrading a module returned error

When I used wirecli to upgrade a module, it returned the following error

In Downloader.php line 169:

  ProcessWire can't be installed because the target folder `/home/#####/webapps/#####/public/site/modules/AddIma
  geUrls` is not empty.
  Use an empty directory or provide an argument where the new project will be created like `wire-cli new <dirname>`


module:upgrade [--check] [--] [<modules>...]

Thanks!

SSL certificate problem

When I try to "wirecli new" on my local machine, I get the error: Error loading sha master, curl request failed (status code: 0, url: https://raw.githubusercontent.com/processwire/processwire/master/wire/core/ProcessWire.php). cURL error: SSL certificate problem: unable to get local issuer certificate

Does it perhaps a linux-installation? (I am using Windows)

PHP 8.2 warning

For your info:

When running wirecli serve on PHP 8.2:

Starting PHP server at http://localhost:8080 ...
PHP Deprecated:  Creation of dynamic property Wirecli\Commands\Common\ServeCommand::$helper is deprecated in ..\vendor\wirecli\wire-cli\src\Commands\Common\ServeCommand.php on line 47

Deprecated: Creation of dynamic property Wirecli\Commands\Common\ServeCommand::$helper is deprecated in ..\vendor\wirecli\wire-cli\src\Commands\Common\ServeCommand.php on line 47