Debug options

See also: Tips and tricks (e.g. for if you have a weird FTP server or want to set up SSH key or Kerberos-based login)

Firstly, note that WordShell logs various operations, into the file “log” in the WordShell directory; which by default is ~/.wordshell. Read there for a record of what has happened.

If you want to get a full view of what WordShell is doing (e.g. if you find a problem, or need to send us a fuller report for support), then simply run with the –debug options:

wordshell <other options> --debug

If you want even fuller information, you can specify –debug twice:

wordshell <other options> --debug --debug

There are several other debugging options available. Only expert users are likely to be interested in these. –remotecli is particularly interesting if you want to see what features are available internally.

--debug : Print lots of internal information. Specify twice for even more verbosity.
--disablecache : Disables relying on state of local caches (e.g. of WordPress API calls). Implies --sync.
--disableapi : Do not use WordPress's API ( for any operations. This is mainly useful for debugging.
--disableftptls : For FTP sites, explicitly disables use of encryption (lftp option: ftp:ssl-allow no)
--requireftptls : For FTP sites, explicitly requires use of encryption (lftp option: ftp:ssl-force yes)
--sync : For (S)FTP sites, require initial sync of plugins directory. Normal behaviour is to skip this step if the directory has been synced in the last 3 hours.
--cache : For (S)FTP sites, force skipping initial sync of plugins directory; use with caution. If specified twice, then does so also for filesystem mode sites.
--no(lftp|wget|curl|w3m|elinks|lynx|rsync): Behave as if the indicated binary does not exist on the system
--phpinfo : Get the phpinfo() output from the remote side
--phpversion : Get the phpversion() output from the remote side
--testurl : Tests to see if a WordPress site exists
--remotecli : Drops into a CLI that allows you to run internal commands against the remote site. This mode is not officialy supported; it is an internal interface which is not guaranteed between versions. Use --remotecli= to run command non-interactively (can specify multiple times).
--workdir : Working directory to use (internal data is stored here)

Leave a Reply