README

Omeka-S-Cli is a command line tool to manage Omeka S instances.

Features

Core
- Download specific Omeka S version
- Update Omeka S to any/latest version
- Install Omeka S (init database, create admin user)
- Perform database migrations
- Get core status/version
Manage modules
- Search and download modules from official Omeka S module repository and Daniel Berthereau's module repository
- Download modules from git repositories
- Install, update, upgrade, enable, disable and delete modules
- List all downloaded modules and their status
Manage themes
- Search and download themes from the official Omeka S theme repository
- Download themes from git repositories
- Delete downloaded themes
- List all downloaded themes and their status
Config
- Export list of installed modules and themes
- Get, set and list global settings
- Create database.ini file
User
- List all users
- Add, delete, enable or disable a user
- Manage API keys for a user

Automating Omeka S instance setup

The Omeka-S-Cli tool can be used to automate the setup and configuration of new Omeka S instances. A typical workflow is:

Download and install Omeka S
- core:download <path> [version] to download Omeka S
- config:create-db-ini --dbname <dbname> --username <username> --password <password> --host <host> --port <port> to create the database.ini file
- core:install --admin-name <admin-name> --admin-email <admin-email> --admin-password <admin-password> to run the Omeka S installer
Add users
- user:add <email> <name> <role> [password] to add users
- user:create-api-key <user-id-or-email> <label> to add API keys for users
Download and install modules and themes
- module:download <module> to download a module
- module:install <module> to install a module
- theme:download <theme> to download a theme
Set config options
- config:set <id> <value> to set global settings

Usage

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

Example: List downloaded modules

omeka-s-cli module:list

+--------------------------+----------------------------+---------------+---------+------------------+---------------+-----------------+
| Id                       | Name                       | State         | Version | InstalledVersion | LatestVersion | UpdateAvailable |
+--------------------------+----------------------------+---------------+---------+------------------+---------------+-----------------+
| AdvancedResourceTemplate | Advanced Resource Template | active        | 3.4.43  | 3.4.43           | 3.4.45        | yes             |
| AdvancedSearch           | Advanced Search            | not_installed | 3.4.51  |                  | 3.4.51        |                 |
| Common                   | Common                     | active        | 3.4.72  | 3.4.72           | 3.4.72        |                 |
+--------------------------+----------------------------+---------------+---------+------------------+---------------+-----------------+

You can export almost any command output with the --json option.

Example: Download a module from a repository

The easiest way to download a module is to use its official name. The downloader will search the name in one of the supported module repositories and download the latest zip release.

# omeka-s-cli module:download common

If the module already exists, you can use the --force option to replace it with the newly downloaded version.

You can download a specific module version using the <module>:<version> syntax:

omeka-s-cli module:download common:3.4.67

The official Omeka S module repository does not always have all versions available. In that case, you can use a url to a zip-release or a git repository.

Example: Download a module from a zip release

omeka-s-cli module:download https://github.com/Daniel-KM/Omeka-S-module-Common/releases/download/3.4.65/Common-3.4.65.zip

Example: Download a module from a git repository

omeka-s-cli module:download https://github.com/GhentCDH/Omeka-S-module-AuthCAS.git

You can use the short gh:user/repo syntax for GitHub repositories:

omeka-s-cli module:download gh:GhentCDH/Omeka-S-module-AuthCAS

You can checkout a specific tag, branch or commit by appending #<branch|tag|commit>.

omeka-s-cli module:download https://github.com/Daniel-KM/Omeka-S-module-AdvancedSearch.git#3.4.22
omeka-s-cli module:download gh:Daniel-KM/Omeka-S-module-AdvancedSearch#3.4.22

The installer will run composer install in the module directory if a composer.lock file is present. Other dependencies must be installed manually.

Example: Download a theme

omeka-s-cli theme:download freedom

Or using the GitHub repository:

omeka-s-cli gh:omeka-s-themes/freedom#v1.0.6

Requirements

PHP (>= 8.1) with PDO_MySQL and Zip enabled
Omeka S (>= 4)

Installation

Download omeka-s-cli.phar from the 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

Download/update multiple modules at once
Module dependency checking
Add support for resource templates
Add support for sites and site pages

Credits

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

Frederic Lamsens

Inspired by:

ghentcdh / omeka-s-cli

Maintainers

Details