Differences

This shows you the differences between two versions of the page.

--- cli [2015-01-21 10:39] – [indexer.php] 90.54.200.86
+++ cli [2024-01-31 23:58] (current) – [Finding more CLI plugins] Klap-in
@@ Line 1: / Line 1: @@
 ====== Command Line Tools ======
-[[DokuWiki]] comes with a few PHP scripts meant to be executed from the (UNIX) commandline of the DokuWiki server. **All those scripts are located in the ''<yourWiki>/bin/'' directory.**
+[[DokuWiki]] comes with a few PHP scripts meant to be executed from the (UNIX) commandline of the DokuWiki server. **All the scripts are located in the ''<yourWiki>/bin/'' directory.**
 **Note:** In order to be able to use these scripts you need the PHP CLI interpreter installed on the system.
@@ Line 32: / Line 32: @@
         commit: see $ dwpage.php --help=commit
         lock: see $ dwpage.php --help=lock
+        gmeta: see $ dwpage.php --help=gmeta
+            Displays metadata about a page. There is no ability to write
+            metadata, only read them.
+            e.g. $ dwpage.php -u <user> gmeta [page] <meta tag>. Where <meta tag>
+            can be "date modified" (in quotes) or "last_change date" an empty
+            <meta tag> returns all metadata.
     OPTIONS
@@ Line 37: / Line 43: @@
             e.g. $ ./dwpage.php -hcommit
             e.g. $ ./dwpage.php --help=commit
 ===== indexer.php =====
@@ Line 52: / Line 60: @@
         -q, --quiet    don't produce any output
-This needs to be run as the appropriate user and possibly the right directory to work. e.g. www-data in ~www-data Under debian lenny
+This needs to be run as the appropriate user and possibly the right directory to work. e.g. www-data in ~www-data under debian lenny. So for example, if your wiki is in ''/var/www/wiki'' :
+  sudo -u www-data /var/www/wiki/bin/indexer.php
+If you experience errors, please firstly check that you are calling the script in the //bin// path and not in the ///lib/exe//.
+When working with farms, you can define the animal variable while calling the script. Please note that this is on single command line.
+  animal=example ./bin/indexer.php
 ===== wantedpages.php =====
@@ Line 119: / Line 135: @@
     executed in all repositories found within this DokuWiki installation
 </code>
+===== plugin.php =====
+This tool gives access to all installed [[devel:CLI Plugins]]. Call it without any arguments to get a list of installed plugins:
+  ./bin/plugin.php
+Call the plugin's help screen to learn more
+  ./bin/plugin.php <pluginname> -h
+====Finding more CLI plugins====
+Use [[plugintype>256#extension__table|CLI Plugins]] to add other functionality to command line.
+A summary of plugins which indicate CLI support:
+---- pluginquery -----
+SELECT: name, description
+WHERE:  (type > ? AND type < ?) AND (bestcompatible LIKE ? OR bestcompatible LIKE ? OR compatible = ?)
+VALUES: 255, 512, @DATEMOSTRECENT@, @DATESECONDMOSTRECENT@, (bundled)
+headline: CLI plugins compatible with last two releases
+-----
+To implement such a plugin please have a look at the [[devel:cli plugins|CLI plugins development documentation]].