Warning: This page has not been updated in over over a year and may be outdated or deprecated.
administration:command_line_utilities
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
vufind2:command_line_utilities [2015/12/14 16:43] – [util controller] demiankatz | administration:command_line_utilities [2020/05/27 17:31] – [util category] demiankatz | ||
---|---|---|---|
Line 5: | Line 5: | ||
===== Running the Tools ===== | ===== Running the Tools ===== | ||
- | The command line tools are organized into controllers | + | The command line tools are organized into categories |
- | ==== Using Zend Framework | + | ==== Using the Index Script |
- | In VuFind 2.4 or newer, the most consistent way to run command line tools is to run them through | + | In VuFind 2.4 or newer, the most consistent way to run command line tools is to run them through |
- | The "PHP scripts in directory" | + | The "PHP scripts in directory" |
< | < | ||
- | php $VUFIND_HOME/ | + | php $VUFIND_HOME/ |
</ | </ | ||
+ | |||
+ | The code was implemented using the Zend\Console package until release 7.0, when that package was deprecated and had to be replaced with Symfony\Console. Only the internals changed, so the process of running the scripts remained the same -- see the blog post [[https:// | ||
==== Using Legacy Wrapper Scripts ==== | ==== Using Legacy Wrapper Scripts ==== | ||
- | Prior to VuFind 2.4, the only way to access command line scripts was to run PHP scripts whose filenames corresponded with action names, and which were stored in directories corresponding with controller | + | Prior to VuFind 2.4, the only way to access command line scripts was to run PHP scripts whose filenames corresponded with action names, and which were stored in directories corresponding with category |
< | < | ||
- | php $VUFIND_HOME/ | + | php $VUFIND_HOME/ |
</ | </ | ||
Line 39: | Line 41: | ||
</ | </ | ||
- | Most of these actions are also summarized below, grouped by controller. However, in case this documentation falls out of date, the index.php output is always the most current way of finding all available tools. | + | Most of these actions are also summarized below, grouped by category. However, in case this documentation falls out of date, the index.php output is always the most current way of finding all available tools. |
- | ==== generator controller | + | ==== compile category |
- | The generator controller (introduced in release 2.4) contains | + | The compile category |
- | ==== harvest controller | + | ==== generate category |
- | The harvest | + | The generate category (introduced in release 2.4) contains code generation tools to help automate common VuFind customization tasks. It is documented in more detail on the [[development: |
+ | |||
+ | ==== harvest | ||
+ | |||
+ | The harvest category | ||
Actions: | Actions: | ||
Line 54: | Line 60: | ||
* merge-marc | * merge-marc | ||
- | ==== import | + | ==== import |
- | The import | + | The import |
Actions: | Actions: | ||
* import-xsl \\ Tool for importing XML files into Solr using XSLT. | * import-xsl \\ Tool for importing XML files into Solr using XSLT. | ||
- | * webcrawl \\ Tool for populating the website index when [[indexing websites]]. | + | * webcrawl \\ Tool for populating the website index when [[indexing: |
- | ==== language controller | + | ==== install category |
- | The language controller contains tools for managing | + | Introduced in VuFind 7.0, the install category integrates the formerly stand-alone install.php script with VuFind' |
Actions: | Actions: | ||
+ | * install \\ Run the install script to set up [[development: | ||
+ | ==== language category ==== | ||
+ | |||
+ | The language category contains tools for managing VuFind' | ||
+ | |||
+ | Actions: | ||
+ | |||
+ | * addusingtemplate \\ Create a new string by combining one or more existing strings using a template. | ||
* copystring \\ Copy one language string to another in all of the language files. | * copystring \\ Copy one language string to another in all of the language files. | ||
* delete \\ Delete a language string from all of the language files. | * delete \\ Delete a language string from all of the language files. | ||
* normalize \\ Normalize (sort/ | * normalize \\ Normalize (sort/ | ||
- | ==== util controller | + | ==== scheduledsearch category ==== |
+ | |||
+ | The scheduledsearch category is used for tasks related to VuFind' | ||
+ | |||
+ | Actions: | ||
+ | |||
+ | * notify \\ Send out new notification emails, as needed. | ||
+ | |||
+ | ==== util category | ||
- | The util controller | + | The util category |
Actions: | Actions: | ||
+ | * cleanup_record_cache \\ Clean out the [[configuration: | ||
* commit \\ Commit the Solr index. | * commit \\ Commit the Solr index. | ||
* createHierarchyTrees \\ Populate the hierarchy cache when using [[indexing: | * createHierarchyTrees \\ Populate the hierarchy cache when using [[indexing: | ||
* cssBuilder \\ Compile LESS files into CSS within all themes. | * cssBuilder \\ Compile LESS files into CSS within all themes. | ||
* dedupe \\ Remove duplicate lines from a text file. | * dedupe \\ Remove duplicate lines from a text file. | ||
- | * deletes \\ Remove all of the records in a specified MARC file from the Solr index. | + | * deletes \\ Remove all of the records in a specified MARC or text file from the Solr index. |
+ | * expire_auth_hashes \\ Clean up expired authentication hashes (generated by Email [[configuration: | ||
+ | * expire_external_sessions \\ Clean up the external_sessions database table, when used. | ||
* expire_searches \\ Remove unwanted saved searches from the database. | * expire_searches \\ Remove unwanted saved searches from the database. | ||
* expire_sessions \\ Remove old session data from the database. | * expire_sessions \\ Remove old session data from the database. | ||
* index_reserves \\ Build a Solr index for course reserves. | * index_reserves \\ Build a Solr index for course reserves. | ||
+ | * lint_marc \\ Check a MARC file for errors. | ||
* optimize \\ Optimize the Solr index. | * optimize \\ Optimize the Solr index. | ||
+ | * scssBuilder \\ Compile SCSS files into CSS within all themes. | ||
* sitemap \\ Generate a sitemap for use with search engines. | * sitemap \\ Generate a sitemap for use with search engines. | ||
* suppressed \\ Delete all currently suppressed catalog records from the Solr index. | * suppressed \\ Delete all currently suppressed catalog records from the Solr index. | ||
+ | * switch_db_hash \\ Change the password hashing algorithm in the database and configuration. | ||
---- struct data ---- | ---- struct data ---- | ||
---- | ---- | ||
administration/command_line_utilities.txt · Last modified: 2023/04/20 14:53 by demiankatz