View Source

The DSpace command launcher or CLI interface offers the execution of different maintenance operations. As most of these are already documented in related parts of the documentation, this page is mainly intended to provide an overview of all available CLI operations, with links to the appropriate documentation.

Executing command line operations

The CLI interface is found at [dspace]/bin/dspace. Execute it without arguments or with the -h option to see all available operations. Execute dspace op -h to see details about the op operation.

Examples:

bin/dspace -h

bin/dspace cleanup -h

bin/dspace cleanup

bin/dspace cleanup --verbose

Available operations

General use

bitstore-migrate: Migrate all files (bitstreams) from one assetstore (bitstore) to another
checker: Run the checksum checker
checker-emailer: Send emails related to the checksum checker
classpath: Calculate and display the DSpace classpath
cleanup: Remove deleted bitstreams from the assetstore
community-filiator: Tool to manage community and sub-community relationships
create-administrator: Create a DSpace administrator account (see Installing DSpace)
curate: Perform curation tasks on DSpace objects
database: Perform various tasks / checks of the DSpace database
doi-organiser: Transmit information about DOIs to the registration agency.
dsprop: View the value of a DSpace property from any configuration file (see Configuration Reference)
dsrun: Run a (DSpace) Java class directly (used mainly for test purposes)
embargo-lifter: Pre DSpace 3.0 embargo manager tool used to check, list and lift embargoes
export: Export items or collections
filter-media: Perform the media filtering to extract full text from documents and to create thumbnails
generate-sitemaps: Generate search engine and html sitemaps (see Search Engine Optimization)
harvest: Manage the OAI-PMH harvesting of external collections (see OAI harvesting docs)
import: Import items into DSpace (see Importing and Exporting Items via Simple Archive Format)
index-authority: import authorities and keep SOLR authority index up to date
index-discovery: Update Discovery (Solr) search and browse Index
itemupdate: Item update tool for altering metadata and bitstream content in items (see Updating Items via Simple Archive Format)
make-handle-config: Run the handle server simple setup command
metadata-export: Export metadata for batch editing
metadata-import: Import metadata after batch editing
migrate-embargo: Embargo manager tool used to migrate old version of Embargo to the new one included in dspace3
oai: OAI script manager
packager: Execute a packager
rdfizer: tool to convert contents to RDF
read : execute a stream of commands from a file or pipe
registry-loader: Load entries into a registry (see Metadata and Bitstream Format Registries)
structure-builder: Build DSpace community and collection structure (see Importing Community and Collection Hierarchy)
sub-daily: Send daily subscription notices
test-email: Test the DSpace email server settings are OK
update-handle-prefix: Update handle records and metadata when moving from one Handle prefix to another
user: Create, List, Update, Delete EPerson (user) records
validate-date: Test date-time format rules
version: Show DSpace version and other troubleshooting information

Legacy statistics

Legacy statistics parse the DSpace log files and compile information based on the "[dspace]/config/dstat.cfg" configuration file. They are no longer actively maintained, but still exist in the codebase because there is information they report on that is not yet accessible in (or replaced by) SOLR Statistics. Where possible, we recommend using SOLR Statistics and/or Google Analytics for more accurate data.

stat-general: Compile the general statistics
stat-initial: Compile the initial statistics
stat-monthly: Compile the monthly statistics
stat-report-general: Create the general statistics report
stat-report-initial: Create the initial statistics report
stat-report-monthly: Create the monthly statistics report

SOLR Statistics

Scripts for the statistics that are stored in SOLR:

solr-export-statistics:Export Solr statistics data to CSV (for backup or moving to another server)
solr-import-statistics: Import Solr statistics data from CSV (for restoration, or moving to another server)
solr-reindex-statistics: Reindex Solr statistics data (for upgrades or updates to Solr schema)
stats-log-converter: Convert dspace.log files ready for import into solr statistics
stats-log-importer: Import previously converted log files into solr statistics
stats-log-importer-elasticsearch: Import solr-format converted log files into Elasticsearch Usage Statistics (deprecated)
stats-util: Statistics Client for Maintenance of Solr Statistics Indexes