# wireshell - an extendable ProcessWire command line interface

## 149 posts in this topic

wireshell 1.0.0 is out

Quote

wireshell 1.0.0

Compatibility: ProcessWire 3.x

• Prepares wireshell for ProcessWire 3.x, adds namespace support, only supports ProcessWire 3.x
• Improves module:upgrade command, if no argument is provided it just checks for upgrades
• Extends new command, adds option --src=path/to/source to be able to use a pre-downloaded tgz/zip/folder
• Extends status command, only shows database password if --pass option is provided, shows if an upgrade is available
• Updates upgrade command, removes options dev and devns

-------- Original post -----------

Now this one could be a rather long post about only an experimental niche tool, but maybe a helpful one for some, so stay with me

Intention
Do you guys know "Artisan" (Laravel) or "Drush" (Drupal)? If not: These are command line companions for said systems, and very useful for running certain (e.g. maintenance, installation) task quickly - without having to use the Admin Interface, first and foremost when dealing with local ProcessWire installations. And since it has a powerful API and an easy way of being bootstrapped into CLIs like this, I think such a tool has a certain potential in the PW universe.

It's totally not the first approach of this kind. But: this one should be easily extendable - and is based on PHP (specifically: the Console component of the Symfony Framework). Every command is tidily wrapped in its own class, dependencies are clearly visible, and so on.

( Here was the outdated documentation. Please visit wireshell.pw for the current one )
32 people like this

##### Share on other sites

Just as I'm in the means to build a separate directory for bugfixes, where I just paste in disposable processwire installations. Really great. Will certainly take a look at it later. I can also see this very useful for setting up base installations in a more flexible way than siteprofiles.

2 people like this

##### Share on other sites

Sure I will help with what I can .

Thank you.

4 people like this

##### Share on other sites

Great! Thanks for this, Marcus. So far, everything looks good here on Windows - have only just installed PW-dev, going to work with other commands now. (Update: Everything works like a charm. Looking forward to seeing more Commands.)

For Windows users interested in making this global:

1. Make sure PHP is in your PATH
2. Create a wireshell folder somewhere (also added to your path), and create a wireshell.bat file:
@echo off
php "path\to\wireshell" %*


Then you can run wireshell new --dev anywhere you like.

6 people like this

##### Share on other sites

Thanks for the positive feedback!

• Attach roles on the fly while user creation: $wireshell create-user foo --roles=superuser,editor • Create templates and attach existing fields on the fly with$ wireshell create-template contact --fields=body,sidebar , prevent template file creation with --nofile
• Command aliases now available: c-u, c-t, c-r, s

Now planning field creation.

6 people like this

##### Share on other sites

Ever since I learned about drush I knew PW could benefit greatly from similar tool. Great job, Marcus!

Those "with dashes in-between" comands look a little weird for a cli interface. I saw you can easilly add aliases for commands, so maybe cr showd be included as a third one (as it is quicker to type)? Drush commands comprise of an object being manipulated followed by a "manipulation type". Not saying it is the right way to go, but it is better to choose some naming pattern explicitly.

Wireshell is a bit long too... Why not add an alias like ''wish" (for WIre SHell). It sounds magical, and isn't PW a wish come true?!

Thank you for developing this!

P.S. It kind of bugs me a little that this cli tool is written with symphony, not with PW itself. I am not even close to being able to argue here, but can it even be done?

1 person likes this

##### Share on other sites

Ever since I learned about drush I knew PW could benefit greatly from similar tool. Great job, Marcus!

Those "with dashes in-between" comands look a little weird for a cli interface. I saw you can easilly add aliases for commands, so maybe cr showd be included as a third one (as it is quicker to type)? Drush commands comprise of an object being manipulated followed by a "manipulation type". Not saying it is the right way to go, but it is better to choose some naming pattern explicitly.

Wireshell is a bit long too... Why not add an alias like ''wish" (for WIre SHell). It sounds magical, and isn't PW a wish come true?!

Thank you for developing this!

P.S. It kind of bugs me a little that this cli tool is written with symphony, not with PW itself. I am not even close to being able to argue here, but can it even be done?

Regarding aliases: Yeah, I'm aware of the dash, and wanted to try cr, cu, ct first, but in the case of "cr" Symfony Console bugged me with the following error:

So in favor of consistency (cu. ct. cro?) I went for the dash.

As for "$wish", that was also my first thought (especially regarding the pun), but I learned that - at least on Unix and OS X - there's a programm called "wish" already present (https://www.tcl.tk/) / Edit: and I'm totally open for a "command style standard". The current order "verb-noun" was nothing but a gut decision. Edited by marcus #### Share this post ##### Link to post ##### Share on other sites Seems like you put the same alias for 3 commands... #### Share this post ##### Link to post ##### Share on other sites Seems like you put the same alias for 3 commands... Nope, but since the other two also start with cr.. Console component tends to misunderstand cr as an incomplete command. #### Share this post ##### Link to post ##### Share on other sites Not sure if this can be done with Symfony Console (I've never really looked at it before), but what about create:user, where a colon is used? I must be honest and say that I'm not one for short aliases - have always preferred concise, clear-cut naming. But, I'm sure others appreciate faster typing. ;-) 2 people like this #### Share this post ##### Link to post ##### Share on other sites Not sure if this can be done with Symfony Console (I've never really looked at it before), but what about create:user, where a colon is used? Good idea, totally possible and artisan-y. 1 person likes this #### Share this post ##### Link to post ##### Share on other sites I'm being really silly - of course it's possible. Didn't even look at the source earlier. Simple as pie, like commands in Laravel. Yeah, I just think that it gives a nice factory feel to it. Also, it makes the commands a tad easier to remember, considering there'll probably be quite a few as you go along. #### Share this post ##### Link to post ##### Share on other sites Hi all, With interest of everyone and love for Processwire, I will send a the PR to wireshell . So it will be a a one click installer. 4 people like this #### Share this post ##### Link to post ##### Share on other sites Hi, this tool is really cool idea. It would be great to have command for full PW installation, not just download. I've managed it by modifying original install.php file from PW 2.5 sources. But I'm not sure if it is production ready, it works but I haven't tested all edge cases. It requires config file with configuration array (db connection, profile, admin user credentials, ...). If you are interested I can post it somewhere. I plan to do it also for PW 2.4. With this comes and idea for 'new' command to allow installation of another versions other than the latest. EDIT: ... So it will be a a one click installer. Hari KT, don't you have the same intention? What do you mean by 'one click installer'. Installer for wireshell or for PW? #### Share this post ##### Link to post ##### Share on other sites @Richard: Hari KT said in his post he will send a PR (Pull Request) to WireShell. So it will be a one click step installer for WireShell, I think. #### Share this post ##### Link to post ##### Share on other sites @Horst: Yes, I think so from his message, but I'm not sure because he is also trying to make the PW cli installer (according to this thread: https://processwire.com/talk/topic/9124-command-line-installer/?hl=installer ). #### Share this post ##### Link to post ##### Share on other sites Thanks for the proposals regarding an installer process, @HariKT and @Richard. A command named "new" definitely promises more than a download, that's right. But for this command I was just tipping my toe in the water, and testdriving the Console component, mimiking "laravel new" (which actually just is a download since there's no installation in the classic sense). Actually your thread about a command line installation of PW got me started with Wireshell in the first place So it's really cool that you'll contribute. Looking forward to the PR! @Richard, it would be cool if you can post your approach to this. Frankly speaking I'm still in the learning phase regarding whats really possible with the API and would be glad if we could discuss in this thread the best approach about this - probably - most important command of Wireshell 1 person likes this #### Share this post ##### Link to post ##### Share on other sites @Richard, it would be cool if you can post your approach to this. So here is the gist: https://gist.github.com/uiii/f1877686bca81fe6d668. See the comment below the gist. 3 people like this #### Share this post ##### Link to post ##### Share on other sites I've just removed unnecessary code from install.php, modify output for console and add cmd options. #### Share this post ##### Link to post ##### Share on other sites I think this is a great project. 1 person likes this #### Share this post ##### Link to post ##### Share on other sites Big update! Version 0.3.0 comes with: • a new "NewCommand" provided by HariKT! Big thanks again. This contribution should lead to a better workflow with Wireshell since it opens up the possibility to install PW via command line in a convenient way • A command for creating fields • A command for assigning fields to existing templates • A generic backup command (DB dump) • Commands for en/disabling modules (downloading them via Wireshell is still on my bucket list) • A little command outputting the currently installed ProcessWire version • An unified approach to naming commands and classes: entity:verb, so for example user:create • I dropped the "(Experimental)" from the topic's title Read more about the available new commands and their options in the readme. If you have an older version of Wireshell installed, make sure you "$ composer update" it in order to get the new dependencies. And we're on packagist now: https://packagist.org/packages/wireshell/wireshell

14 people like this

##### Share on other sites

Great! Thanks for this, Marcus. So far, everything looks good here on Windows - have only just installed PW-dev, going to work with other commands now. (Update: Everything works like a charm. Looking forward to seeing more Commands.)

For Windows users interested in making this global:

1. Make sure PHP is in your PATH
2. Create a wireshell folder somewhere (also added to your path), and create a wireshell.bat file:
@echo off
php "path\to\wireshell" %*


Then you can run wireshell new --dev anywhere you like.

Since Wireshell is on packagist now and "composer global require wireshell/wireshell" installs it into "~/.composer/vendor/bin/wireshell" on Linux, could you test/check what the comparable Windows path or workflow would be? I'm currently rewriting (simplifying) the installation guide. Cheers!

2 people like this

##### Share on other sites

On Windows, it installs to C:\Users\<user>\AppData\Roaming\Composer\vendor\wireshell\wireshell\ ... Not sure what the best way of making this global is, other than making a batch file look specifically in that directory. I must admit: I'm not a composer fundi, but I get the basics...

Update: In fact, if I run wireshell directly from the above directory (using php wireshell), it doesn't run because it's looking for vendor/autoload.php in that directory too. If I run the nasty php vendor/wireshell/wireshell/wireshell from the C:\Users\<user>\AppData\Roaming\Composer directory, it works. Phew, quite messy. But, like I said, I'm no fundi - there must be a better way to do this.

1 person likes this

##### Share on other sites

On Windows, it installs to C:\Users\<user>\AppData\Roaming\Composer\vendor\wireshell\wireshell\ ... Not sure what the best way of making this global is, other than making a batch file look specifically in that directory. I must admit: I'm not a composer fundi, but I get the basics...

Update: In fact, if I run wireshell directly from the above directory (using php wireshell), it doesn't run because it's looking for vendor/autoload.php in that directory too. If I run the nasty php vendor/wireshell/wireshell/wireshell from the C:\Users\<user>\AppData\Roaming\Composer directory, it works. Phew, quite messy. But, like I said, I'm no fundi - there must be a better way to do this.

Thanks so far! I discovered an installation guide for "laravel install" on windows: http://www.bitspedia.com/2014/09/how-to-install-and-make-first-laravel.html :

1. Add your ~/.composer/vendor/bin path into Path environmental variable, so that Windows Command Prompt could identify laravel command that would be used later to install Laravel and doing other tasks. In my case the path where its located is: C:\Users\UserName\AppData\Roaming\Composer\vendor\bin

so I added it into my Path environmental variable. Must restart your Shell or Command-Prompt so that updated Path variables is loaded.

And when I googled "windows Path environmental variable", got this: http://www.computerhope.com/issues/ch000549.htm. This GUI/matrix seems to be the counterpart to .bashrc.

## Create an account

Register a new account

• ### Similar Content

• By Mirza
Hi All,
I have created a script which will create the pages and it should be unpublished.
I have added the status as unpublished by default while first time saving the page as below.
$hotelPage->hotel_website =$hotel['hotelWebsite']; // By default page created will be unpublished state $hotelPage->addStatus(Page::statusUnpublished);$hotelPage->save(); $hotelPage->setOutputFormatting(false); // Add hotel images only after setting output formatting to false$hotelPage->images->add($hotel['hotelImage']);$hotelPage->save(); On the same time, saving the hotel image as well and triggering the save method.
But when I see the created page in the tree, Its shows unpublished but publish_date is not empty(date will be present as created, modified and published are all same)
Now I don't understand why the date is getting filled into the publish field for a page?
Please let me know if am doing something wrong.
• By benbyf
Hello,
Does anyone know whether the is a place detailing the structure your admin theme should take when creating one? e.g. I see UiKit, Reno and Default admin themes all have default.php, init.php, controller.php files, is this a stylisitic choice or a prerequisite for any admin theme module?
Thanks!

• I am using the translation function (either $this->_() or __()) within a module that responds to AJAX API calls - there isn't really a page that is being served. When I supply a string with an apostrophe, e.g., __('Book \'em danno') It is formatted as Book &#039;em danno Is there some way to prevent output formatting when retrieving strings using the translation functions? • By dweeda At the top of each of my main pages, I want to redirect to my login page if the session is timed out. How can I use the PW API to test for this?$user->isLoggedin() doesn't seem to do it, like I expected.
THX
• By Sipho
I wish to access a template's allowed templates for it's children from the API. This one:

I am pretty sure this is possible, but I can't seem to find it anywhere in the documentation. If this is not possible, is there some way of assigning properties to templates? So like fields that already have a value on all pages using that template.