2017 © Pedro Peláez
 

library client-cli

CLI to use the Rokka service, using PHP

image

rokka/client-cli

CLI to use the Rokka service, using PHP

  • Wednesday, July 11, 2018
  • by rokka
  • Repository
  • 2 Watchers
  • 4 Stars
  • 2,959 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 2 Forks
  • 3 Open issues
  • 21 Versions
  • 45 % Grown

The README.md

Rokka PHP CLI

Build Status StyleCI Latest Stable Version, (*1)

A stand-alone console client for rokka.io, built with Symfony components., (*2)

Download: .phar

The cli can be used as a standalone commandline tool. Download the .phar from our releases page and put it into e.g. /usr/local/bin/rokka-cli., (*3)

Installation: Composer

Note: If you are using Symfony, use the RokkaClientBundle which provides these commands in a Symfony application., (*4)

  • composer require rokka/client-cli
  • run the CLI from vendor/bin/rokka-cli

Commands

Available commands:, (*5)

  • image:copy: Copy the given image to another organization
  • image:copy-all: Copies all existing image between organizations
  • image:delete: Delete an image from a Rokka organization by its hash
  • image:delete-all: Delete all images from a Rokka organization
  • image:delete-subjectarea: Remove the subject area metadata from an image
  • image:download: Download a source image from Rokka, given its hash
  • image:info: Given an image hash, output its details (name, filesize, metadatas)
  • image:list: List all uploaded images (includes offset, limit, sort and image-search options)
  • image:render: Render an image with a specified stack
  • image:restore: Restore the given image
  • image:set-subjectarea: Set the SubjectArea metadata to a given image

  • image:upload: Upload a given image file to Rokka.io, (*6)

  • stack:create: Create a stack, (*7)

  • stack:clone: Copies a given ImageStack to another name (or to a different organization)
  • stack:clone-all: Clones all ImageStack to another organization
  • stack:list: List all available ImageStacks
  • stack:info: Given a Stack name, output its details (name, operations, options)

  • stack:delete: Removes an ImageStack, (*8)

  • organization:create: Creates a new organization, (*9)

  • organization:info: Prints the details of a given organization
  • organization:membership:add: Adds a membership given a user email and role

  • organization:membership:info: Prints the details of a given membership (by user email and organization), (*10)

  • user:create: Creates and register a new User on Rokka.io, (*11)

Configuration

Without configuration, the command will only list the operations that are possible when not logged in. Use the organization:create and user:create commands with the --save-as-default option to initialize the configuration with your user. You can then copy the rokka.yml file to .rokka.yml in your home directory., (*12)

If you have an existing account, create the file .rokka.yml with the following content in your home directory:, (*13)

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

rokka-cli looks for rokka.yml in the current working directory or .rokka.yml in your home directory., (*14)

Development

Building rokka-cli.phar

Rokka-CLI uses Box to build executable Phars., (*15)

  • Checkout the GIT repository
  • Run make dist
  • The .phar should be at dist/rokka-cli.phar

Running 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/

The Versions

11/07 2018

dev-master

9999999-dev https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

11/07 2018

dev-restore-and-copy-sourceimage

dev-restore-and-copy-sourceimage https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

11/07 2018

1.6.2

1.6.2.0 https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

11/07 2018

dev-install-in-bin

dev-install-in-bin https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

14/05 2018

1.6.1

1.6.1.0 https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

16/04 2018

1.6.0

1.6.0.0 https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

15/03 2018

1.5.1

1.5.1.0 https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

15/03 2018

dev-configuration-organization-bug

dev-configuration-organization-bug https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

19/02 2018

1.5.0

1.5.0.0 https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

05/12 2017

1.4.0

1.4.0.0 https://rokka.io/

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

29/11 2017

dev-symfony-4

dev-symfony-4 https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

03/11 2017

dev-develop

dev-develop https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

03/11 2017

1.3.0

1.3.0.0 https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

30/08 2017

1.2.1

1.2.1.0 https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

29/08 2017

1.2.0

1.2.0.0 https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

10/05 2017

dev-fix-api-changes

dev-fix-api-changes https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

12/04 2017

1.1.0

1.1.0.0 https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

08/03 2017

dev-update-dynamic-metadata-handling

dev-update-dynamic-metadata-handling https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

02/03 2017

dev-add-search-options

dev-add-search-options https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Emanuele Panzeri

rokka rokka.io

18/11 2016

1.0.1

1.0.1.0 https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

by Emanuele Panzeri

rokka rokka.io

15/11 2016

1.0.0

1.0.0.0 https://github.com/rokka-io/rokka-client-php-cli

CLI to use the Rokka service, using PHP

  Sources   Download

MIT

The Requires

 

by Emanuele Panzeri

rokka rokka.io