NAME

catmandu - LibreCat command line tools

SYNOPSIS

catmandu [COMMAND] [-?hqv] [long options...] [ARGS]

catmandu help data

catmandu help config

# Import a JSON file into the default store (set in catmandu.yml)
catmandu data --into-bag data < test.json

# Import a YAML file into the default store
catmandu data --from-importer YAML --into-bag data < test.yaml

# Export a JSON file from the default store
catmandu data --from-bag data > test.json

# Export a YAML file from the default store
catmandu data --from-bag data --into-exporter YAML > test.yaml

COMMANDS

data OPTIONS

Data manipulation commands: import, export, store, search.

help COMMAND

Documentation about command line options.

OPTIONS

Basic Startup Options

-v

Verbose output.

-h

-?

Display the help screen.

--lib-path PATH

-I

Specifies Perl library include paths, like perl's -I option. This option is repeatable.

--load-path PATH

-L PATH

Search upwards from this path for configuration files and accompanying lib directories. This option is repeatable.

Data Options

--from-store STORE

Read items from a Catmandu::Store such as: DBI, MongoDB, Solr, ElasticSearch, ...

--from-importer IMPORTER

Read items from a Catmandu::Importer such as: YAML, JSON, CSV, MARC, OAI ...

--from-bag BAG_NAME

This option should be used in combination with a --from-store. Select from the Store only the items belonging to the bag BAG_NAME.

--from-OPTION OPTION_VALUE

To include configuration options to a Catmandu::Store or Catmandu::Importer an argument with prefix '--from-' can be used. E.g. to provide an 'url' to an Importer use:

--from-url http://my.url

--into-exporter EXPORTER

Add each item read into a Catmandu::Exporter such as: JSON, YAML, Template, XLS, ...

--into-store STORE

Add each item read into a Catmandu::Store such as: DBI, MongoDB, Solr, ElasticSearch, ...

--into-bag BAG_NAME

This option should be used in combination with a --into-store. Add each item into the Store with bag BAG_NAME.

--into-OPTION OPTION_VALUE

To include configuration options to a Catmandu::Store or Catmandu::Exporter an argument with prefix '--into-' can be used. E.g. to provide an 'url' to an Exporter use:

--into-url http://my.url

--fix EXPRESSION

--fix FILE

When exporting or storing apply a fix EXPRESSION or all the fixes in FILE on each item. This option is repeatable.

--start NUM

When exporting or storing data skip the first NUM items.

--total NUM

When exporting of storing data process only a total NUM of items.

--replace

When storing data first delete all the items in the Store or Bag.

--query QUERY

--cql-query QUERY | -q QUERY

When a Store is searchable execute and return the results. Using the --cql-query or -q option the CQL query language can be used (if supported).

--limit NUM

Limit the number of results returned from the searchable results to NUM.

--count

Report the number of items processed.