README

Omeka 的命令行工具

该工具允许通过命令行界面与 Omeka 交互。它还为 Omeka 插件提供创建自定义命令所需的一切。

使用方法

omeka-cli [-h | --help]
omeka-cli [-V | --version]
omeka-cli <command> [options] [arguments]

可用命令

check-updates     check for updates
help              print help for a specific command
status            print status of current Omeka installation
install           install Omeka
list              list available commands
options           list, get and set Omeka options
plugin-disable    disable a plugin
plugin-download   downloads a plugin
plugin-enable     enable a plugin (install & activate)
plugin-list       list all plugins
plugin-search     search a plugin
plugin-uninstall  uninstall a plugin
plugin-update     update a plugin
snapshot          create a snapshot
snapshot-restore  restore a snapshot
upgrade           upgrade Omeka

要求

• PHP (>= 7.2) 以及以下扩展
  • Zip
  • PDO 和 PDO_MYSQL 驱动
• git

安装

使用 composer

# For the latest released version
composer global require biblibre/omeka-cli

# For the latest dev version
composer global require biblibre/omeka-cli:@dev

然后将 ~/.config/composer/vendor/bin 添加到您的 PATH

export PATH=~/.config/composer/vendor/bin:$PATH

使用 phar

从 发布 页面下载最新的 omeka-cli.phar。

wget https://github.com/biblibre/omeka-cli/releases/download/$VERSION/omeka-cli.phar
chmod +x omeka-cli.phar
sudo mv omeka-cli.phar /usr/local/bin/omeka-cli

使用源代码

git clone https://github.com/biblibre/omeka-cli.git
cd omeka-cli
composer install --no-dev
bin/omeka-cli --version

创建自定义命令

要创建名为 foo:bar 的自定义命令（使用 Foo 插件），将以下代码放入您插件主类的 initialize 钩子中

$events = Zend_EventManager_StaticEventManager::getInstance();
$events->attach('OmekaCli', 'commands', function() {
    return array(
        'Foo_Bar',
    );
});

并定义一个扩展自 OmekaCli\Command\AbstractCommand 的类 Foo_Bar

您必须实现至少 configure 和 execute 方法。

例如

use OmekaCli\Command\AbstractCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class Foo_Bar extends AbstractCommand
{
    protected function configure()
    {
        $this->setName('foo:bar');
        $this->setDescription('print something to stdout');
        $this->setAliases(array('bar'));
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln('Hello, omeka-cli!');

        return 0;
    }
}

然后您可以以这种方式运行命令

omeka-cli foo:bar [OPTION...] [ARG...]

或使用别名

omeka-cli bar [OPTION...] [ARG...]

要了解如何从插件中实际创建自定义命令，请参阅插件 Foo。

运行测试

如果您想测试 omeka-cli，将 phpunit.xml.dist 复制到 phpunit.xml，并根据需要更改环境变量 OMEKA_DB_*。如果您想在每次运行之前避免下载 Omeka，您可以手动下载 ZIP 文件，并将其实际路径放入 OMEKA_ZIP_PATH。

完成这些后，运行

composer install
vendor/bin/phpunit

许可协议

GPL 3.0+