https://github.com/wirecli/wire-cli
🌀 An extendable CLI tool for ProcessWire developers. Automate common tasks and manage your ProcessWire projects effortlessly.
https://github.com/wirecli/wire-cli
cli-tool processwire workflow
Last synced: 2 months ago
JSON representation
🌀 An extendable CLI tool for ProcessWire developers. Automate common tasks and manage your ProcessWire projects effortlessly.
- Host: GitHub
- URL: https://github.com/wirecli/wire-cli
- Owner: wirecli
- License: mit
- Created: 2023-07-13T19:41:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-09T15:16:28.000Z (8 months ago)
- Last Synced: 2025-11-01T17:13:38.012Z (3 months ago)
- Topics: cli-tool, processwire, workflow
- Language: PHP
- Homepage:
- Size: 524 KB
- Stars: 17
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 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](https://symfony.com/doc/current/components/console.html) 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](https://github.com/baumrock/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
```
### Path Arguments (e.g., --src)
- 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:
## Documentation
For detailed documentation and usage examples, please refer to the [official documentation](https://github.com/wirecli/wire-cli).
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](https://github.com/wirecli/wire-cli).
## 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](LICENSE.md).