rokka/client-cli

使用 PHP 调用 Rokka 服务的 CLI 工具

1.10.1 2024-01-09 16:05 UTC

README

Build Status StyleCI Latest Stable Version

A stand-alone console client for rokka.io, built with Symfony components.

下载:.phar

该 CLI 可以作为一个独立的命令行工具使用。从我们的 发布页面 下载 .phar 文件,并将其放入例如 /usr/local/bin/rokka-cli 的路径中。

安装:Composer

注意:如果您正在使用 Symfony,请使用 RokkaClientBundle,它可以在 Symfony 应用程序中提供这些命令。

  • composer require rokka/client-cli
  • vendor/bin/rokka-cli 运行 CLI

命令

可用命令

  • image:copy:将给定的图像复制到另一个组织

  • image:copy-all:在组织之间复制所有现有图像

  • image:delete:通过其哈希值从 Rokka 组织中删除图像

  • image:delete-all:从 Rokka 组织中删除所有图像

  • image:delete-subjectarea:从图像中删除主题区域元数据

  • image:download:通过哈希值从 Rokka 下载源图像

  • image:info:给定图像哈希值,输出其详细信息(名称、文件大小、元数据)

  • image:list:列出所有上传的图像(包括偏移量、限制、排序和图像搜索选项)

  • image:render:使用指定的堆栈渲染图像

  • image:restore:恢复给定的图像

  • image:set-subjectarea:将主题区域元数据设置给给定的图像

  • image:upload:将给定的图像文件上传到 Rokka.io

  • stack:create:创建堆栈

  • stack:clone:将给定的 ImageStack 复制到另一个名称(或不同的组织)

  • stack:clone-all:将所有 ImageStack 复制到另一个组织

  • stack:list:列出所有可用的 ImageStacks

  • stack:info:给定堆栈名称,输出其详细信息(名称、操作、选项)

  • stack:delete:删除 ImageStack

  • organization:create:创建新的组织

  • organization:info:打印给定组织的详细信息

  • organization:membership:add:通过用户电子邮件和角色添加成员资格

  • organization:membership:info:打印给定成员资格的详细信息(通过用户电子邮件和组织)

  • user:create:在 Rokka.io 上创建并注册新用户

配置

在没有配置的情况下,命令将只列出未登录时可能进行的操作。使用带有 --save-as-default 选项的 organization:createuser:create 命令初始化配置为您的用户。然后,您可以将 rokka.yml 文件复制到您的家目录中的 .rokka.yml

如果您有现有帐户,请在家目录中创建包含以下内容的 .rokka.yml 文件

rokka_cli:
    api_key: your-api-key
    organization: organization-name

rokka-cli 在当前工作目录中寻找 rokka.yml,或者在您的家目录中寻找 .rokka.yml

开发

构建 rokka-cli.phar

Rokka-CLI 使用 Box 来构建可执行的 Phars。

  • 检出 GIT 仓库
  • 运行 make dist
  • .phar 应该位于 dist/rokka-cli.phar

运行 PHP-CS-Fixer

curl http://cs.sensiolabs.org/download/php-cs-fixer-v2.phar > /tmp/php-cs-fixer.phar
php /tmp/php-cs-fixer.phar  fix -v --diff --using-cache=yes src/