flamsens / omeka-s-cli

Omeka S CLI tool

Omeka S CLI

Omeka S CLI is a tool developed by Libnamic that allows to manage Omeka S installs using a command line interface (CLI). The goal is to help maintain Omeka S and save time by automating daily operations such as module or theme installs and updates.

About

This tool was created for Libnamic Hosting and is included by default in all Omeka S installs as an extra feature for its customers. Given the benefits experienced with it, it was decided to publish it as open source under GNU AGPLv3 license, so anyone can benefit from it and contribute.

Libnamic Hosting

Libnamic provides a hosting service specialized in Omeka that offers specific tools and expertise from a team that actually understands the application. Additionally, Libnamic Hosting achieves an average 70% of performance improvement when comparing page generation times with other main competitors. Performance is key with a big repository, and with Libnamic Hosting, a TTFB of 1s can easily be lowered to ~300ms just by switching hosting providers. Libnamic also provides Omeka consultancy and development. See Libnamic Digital Humanities

Install

You can just clone the repository and create a symlink in your /usr/bin folder to the main php file, omeka-s-cli.php.

Usage

The available main commands are:

• backup
• config
• core
• db
• info
• module
• theme Run them to see what options are availbe. We're working on creating more extensive documentation.

Examples

Core update (not for Docker/containerized installs)

Module management

Theme management

Disclaimer

This software is experimental and might not work as expected in some cases, especially since this is an initial version of it. There is no warranty and the authors and maintainers will not be liable for any damages or problems. Please keep regular backups of your sites to avoid problems. For example, Libnamic Hosting creates off-site backups of Omeka sites every 4 hours and stores them for 60 days.