Omeka-S-Cli

Omeka-S-CLI is a command line tool to manage Omeka S installs.

Features

• Manage modules
  • Search and download modules from official Omeka S module repository and Daniel Berthereau's module repository
  • Install, enable, disable, upgrade, uninstall and delete downloaded modules
  • List all downloaded modules and their status
• Manage themes
  • Search and download themes from the official Omeka S theme repository
  • Install, enable, disable, uninstall and delete downloaded themes
  • List all downloaded themes and their status
• Export config
  • Export list of installed modules and themes

Usage

omeka-s-cli [ - h | --help ]
omeka-s-cli <command> --help
omeka-s-cli <command> [options]

Available commands:

config
  config:modules         Export list of modules
  config:themes          Export list of themes
module
  module:delete          Delete module
  module:disable         Disable module
  module:download        Download module
  module:enable          Enable module
  module:install         Install module
  module:list            List downloaded modules
  module:repositories    List available module repositories
  module:search          Search/list available modules
  module:status          Get module status
  module:uninstall       Uninstall module
  module:upgrade         Uninstall module
theme
  theme:delete           Delete theme
  theme:download         Download theme
  theme:list             List downloaded themes
  theme:search           Search/list available modules
  theme:status           Get theme status

Requirements

• PHP (>= 8) with PDO_MySQL and Zip enabled
• Omeka-S (>= 3.2)

Installation

• Download omeka-s-cli.phar from latest release.
• Run with php omeka-s-cli.phar or move it to a directory in your PATH and make it executable.

Build

This project uses https://github.com/box-project/box to create a phar file.

box global install

composer global require humbug/box

compile phar

box compile

To do

• Core management (version, latest-version, install, update)
• Config management (list, get, set)

Credits

Built @ the Ghent Center For Digital Humanities, Ghent University by:

• Frederic Lamsens

Inspired by:

• Libnamic Omeka S Cli
• biblibre Omeka CLI