wireshell

Jump to navigation

ProcessWire command-line companion

A command-line interface for CMS/CMF ProcessWire based on Symfony Console component. Can be easily extended through ProcessWire's ability of being bootstrapped into other applications, its great API and Symfony Console's modular command approach.

wireshell

Installation

wireshell requires Composer and a local PHP installation >= 5.4.0, and, of course, ProcessWire.

  • Download and install Composer (if it isn't on your system already), globally:
  • Run $ composer global require wireshell/wireshell
  • Add wireshell to your system path: export PATH="$HOME/.composer/vendor/bin:$PATH" in .bashrc (or similar) on unix-based systems, and %appdata%\Composer\vendor\bin on Windows.
  • You should be able to run $ wireshell or $ php wireshell now.

Updating

You can update update wireshell like any other Composer package: $ composer global require wireshell/wireshell:dev-master.

Documentation

For detailed usage please go to wireshell docs.

Extending

Symfony Console

Symfony Console is part of the Symfony Framework and a great workbench for command line apps. There are other command line interfaces for CMS/CMF's around, such as DrupalConsole, that are also based on Console. In general, commands are single classes with a transparent set of dependencies (Input, Output), wrapped in a single app. Find out more in the official documentation, and check out sample code. And already created wireshell commands as well.

Contributing

Thanks for your interest in extending wireshell:

  • Please point your GitHib Pull Request towards the develop branch.
  • In lieu of a formal styleguide, take care to maintain the existing coding style. Note the .editorconfig file in the repo.

Licence

Unless stated differently in particular files, wireshell is licenced under MIT, see: https://github .com/wireshell/wireshell/blob/master/LICENCE.md.

Contributors & Thanks

Core

  • justonestep (Bea Dav) (GitHub)
  • marcus-herrmann (GitHub)
  • clsource (Camilo Castro) (GitHub)

Community

Thanks to the amazing folks who contributed to wireshell! In loosely chronological order: Hari and Mister X for the super-powered "New" command, clsource and horst-n for their additions to "Status" command, for code refactoring and consulting, clsource for consulting on documentation and Code Of Conduct, justonestep for "Module Download" command, enhanced "User Create" and "User Update", "User List", "User Delete" commands, nicoknoll for the API to his service modules.pw and the resulting "Module Generate" command.

Code Of Conduct

Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/.

Support

Check out ProcessWire Recipes · Impressum und Datenschutzerkärung