Table of Contents

  1. Introduction
  2. fedora-dsinfo
  3. fedora-export
  4. fedora-find
  5. fedora-ingest
  6. fedora-ingest-demos
  7. fedora-convert-demos
  8. fedora-purge
  9. fedora-modify

Introduction

The Fedora client distribution comes with several command-line utilities that can be used to run some common operations without bringing up the GUI or writing your own SOAP client. A description and usage instructions for each follows.

This guide assumes you have correctly installed the Fedora client distribution as per the install guide, including having set up your PATH and FEDORA_HOME appropriately. The command-line scripts are located in FEDORA_HOME/client/bin/. In Windows, these commands resolve to batch files (.bat); in Unix, they resolve to shell scripts (.sh).

fedora-dsinfo

fedora-dsinfo [hostname] [port-number] [user] [pass] [pid]

Where:

Example:

fedora-dsinfo localhost 8080 fedoraAdmin fedoraAdmin demo:5

Displays key information about each of an object's datastreams.

fedora-export

fedora-export [HST:PRT] [USR] [PSS] [PID|FTYPS] [FORMAT] [ECONTEXT] [PATH]

Where:

Examples:

fedora-export example.com:80 fedoraAdmin fedoraAdmin demo:1 foxml1.0 migrate

Exports demo:1 for migration in FOXML format (from example.com:80 to the current directory).



fedora-export example.com:80 fedoraAdmin fedoraAdmin DMO default default /tmp/fedoradump

Exports all objects in the default export format and context (from example.com:80 to directory /tmp/fedoradump).

fedora-find

fedora-find [hostname] [port-number] [fieldList] [searchString]

Where:

Example:

fedora-find localhost 8080 "pid fType title description" "fedora"

(shows the pid, Fedora object type, title, and description fields of each object that has the word fedora somewhere in it's indexed fields.)

A simple way to search a repository's indexed fields. More advanced searches can be done with the web-based search interface at http://host:port/fedora/search, or the Admin GUI's search interface.

fedora-ingest

fedora-ingest f[ile] [PATH] [FORMAT] [THST:TPRT] [TUSR] [TPSS] [LOG]

fedora-ingest d[ir] [PATH] [FORMAT] [FTYPS] [THST:TPRT] [TUSR] [TPSS] [LOG]

fedora-ingest r[epos] [SHST:SPRT] [SUSR] [SPSS] [PID|FTYPS] [THST:TPRT] [TUSR] [TPSS] [LOG]

Where:

Examples:

fedora-ingest f obj1.xml foxml1.0 myrepo.com:80 jane jpw

Ingests obj1.xml (encoded in foxml1.0 format) from the current directory into the repository at myrepo.com:80 as user 'jane' with password 'jpw'. The logmessage will be system-generated, indicating the source path+filename.

fedora-ingest d c:\archive foxml1.0 M myrepo.com:80 jane janepw ""

Traverses entire directory structure of c:\archive, and ingests any file that looks like a behavior mechanism object (M). It assumes all files will be in the XML format 'foxml1.0' and will fail on ingests of files that are not of this format. All log messages will be the quoted string.

fedora-ingest d c:\archive foxml1.0 ODM myrepo.com:80 jane janepw "for jane"

Same as above, but ingests all three types of objects (O,D,M).

fedora-ingest r jrepo.com:8081 mike mpw demo:1 myrepo.com:80 jane jpw ""

Ingests the object whose pid is 'demo:1' from the source repository 'srcrepo.com:8081' into the target repository 'myrepo.com:80'. The object will be exported from the source repository in the default export format configured at the source. All log messages will be empty.

fedora-ingest r jrepo.com:8081 mike mpw O myrepo.com:80 jane jpw ""

Same as above, but ingests all data objects (type O).

fedora-ingest-demos

fedora-ingest-demos [hostname] [port-number] [user] [pass]

Where:

Example:

fedora-ingest-demos localhost 8080 fedoraAdmin fedoraAdmin

A convenient script to ingest all included demo objects for a new Fedora installation. See the Demo guide for descriptions of these objects. Note: This script should not be run until you have ensured that the hostname and port numbers in the demo objects have been corrected (with the fedora-convert-demos script) to use the actual hostname and port of your Fedora server.

fedora-convert-demos

fedora-convert-demos [fromHostName] [fromPortNum] [toHostName] [toHostNum] [fedoraHomeDir]

Where:

Example:

fedora-convert-demos localhost 8080 www.fedora.info 80 c:\fedora-2.0

Converts URLs in the demo objects from one host/port combination to another. After running this script with your repository's hostname, the demo objects can successfully be ingested.

Background: The demo objects that come with the Fedora client have embedded URLs inside them that assume the server is running on a machine called localhost on port number 8080. Those URLs must be changed to reflect the actual host and port the server is running on. Rather than search through all the demo files and change the references by hand, you can just run this script. It is not necessary to run this script if you have already run fedora-ingest-demos succcessfully and wish to change the hostname and port of the Fedora server, as the demo objects are already in the repository and the references inside them will automatically be corrected by the server.

fedora-purge

fedora-purge [hostname] [port-number] [user] [pass] [pid] [logMessage]

Where:

Example:

fedora-purge localhost 8080 fedoraAdmin fedoraAdmin demo:6 "It was just a test object"

Permanently removes an object from the repository. Note: Behavior Definition objects (BDefs) cannot be removed if there are objects that depend on them. When removing a BDef from the repository, first the dependent object(s) should be removed, then the implementing Behavior Mechanism(s), then the BDef itself.

fedora-modify

fedora-modify [hostname:port] [user] [password] [directives-filepath] [log-filepath] [validate-only-option]*

Where:

The fedora-modify command line utility enables the running of the batch modify utility of the Administrator GUI client from the command line.