PHPackages                             rokka/client-cli - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. rokka/client-cli

ActiveLibrary[CLI &amp; Console](/categories/cli)

rokka/client-cli
================

CLI to use the Rokka service, using PHP

1.10.3(9mo ago)7246.1k↓34%5[5 issues](https://github.com/rokka-io/rokka-client-php-cli/issues)2MITPHPPHP ^8.0CI passing

Since Nov 15Pushed 2mo ago3 watchersCompare

[ Source](https://github.com/rokka-io/rokka-client-php-cli)[ Packagist](https://packagist.org/packages/rokka/client-cli)[ Docs](https://rokka.io/)[ RSS](/packages/rokka-client-cli/feed)WikiDiscussions 1.x Synced 1mo ago

READMEChangelog (10)Dependencies (9)Versions (33)Used By (2)

Rokka PHP CLI
=============

[](#rokka-php-cli)

[![Build Status](https://camo.githubusercontent.com/8e31e30f0f7d266d8c8bf3d2db529395a35d8fb722d6e597a9f36b9d87b18320/68747470733a2f2f6170692e7472617669732d63692e6f72672f726f6b6b612d696f2f726f6b6b612d636c69656e742d7068702d636c692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/rokka-io/rokka-client-php-cli)[![StyleCI](https://camo.githubusercontent.com/a9dde038e8b4e7c03666ff313175d12c22cd9c5ba14203782173e94acdeceffd/68747470733a2f2f7374796c6563692e696f2f7265706f732f35343230393433392f736869656c64)](https://styleci.io/repos/54209439)[![Latest Stable Version](https://camo.githubusercontent.com/b852f185b75147f2cf053660e92f923c47bc475298899056465e9607d20adee1/68747470733a2f2f706f7365722e707567782e6f72672f726f6b6b612f636c69656e742d636c692f76657273696f6e2e706e67)](https://packagist.org/packages/rokka/client-cli)

A stand-alone console client for [rokka.io](https://rokka.io), built with Symfony components.

Download: .phar
---------------

[](#download-phar)

The cli can be used as a standalone commandline tool. Download the .phar from our [releases](https://github.com/rokka-io/rokka-client-php-cli/releases)page and put it into e.g. `/usr/local/bin/rokka-cli`.

Installation: Composer
----------------------

[](#installation-composer)

Note: If you are using Symfony, use the [RokkaClientBundle](https://github.com/rokka-io/rokka-client-bundle/) which provides these commands in a Symfony application.

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

Commands
--------

[](#commands)

Available commands:

- `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
- `stack:create`: Create a stack
- `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
- `organization:create`: Creates a new organization
- `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)
- `user:create`: Creates and register a new User on Rokka.io

Configuration
-------------

[](#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.

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

```
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.

Development
===========

[](#development)

Building rokka-cli.phar
-----------------------

[](#building-rokka-cliphar)

Rokka-CLI uses [Box](https://github.com/humbug/box/) to build executable Phars.

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

Running PHP-CS-Fixer
--------------------

[](#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/

```

###  Health Score

54

—

FairBetter than 97% of packages

Maintenance58

Moderate activity, may be stable

Popularity41

Moderate usage in the ecosystem

Community25

Small or concentrated contributor base

Maturity79

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~112 days

Recently: every ~194 days

Total

31

Last Release

85d ago

PHP version history (7 changes)1.0.0PHP ^5.5.0|^7.0.0

1.3.0PHP ^5.6.0 || ^7.0.0

1.4.0PHP ^5.6 || ^7.0

1.9.0PHP ^7.0.8

1.9.7PHP ^7.1|^8.0

1.9.10PHP ^8.0

1.x-devPHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/803a02308898d7176ad6601cc9f1bc9b057a725d5b35f6c0c54995b02a97a977?d=identicon)[rokka](/maintainers/rokka)

![](https://www.gravatar.com/avatar/04293348c41a664329fc652b5885ec3c073e8cca5ab159312eab2a6e8983bcd5?d=identicon)[chregu](/maintainers/chregu)

---

Top Contributors

[![chregu](https://avatars.githubusercontent.com/u/47106?v=4)](https://github.com/chregu "chregu (64 commits)")[![dbu](https://avatars.githubusercontent.com/u/76576?v=4)](https://github.com/dbu "dbu (51 commits)")[![thePanz](https://avatars.githubusercontent.com/u/226021?v=4)](https://github.com/thePanz "thePanz (17 commits)")[![ChristianRiesen](https://avatars.githubusercontent.com/u/1446701?v=4)](https://github.com/ChristianRiesen "ChristianRiesen (8 commits)")[![Tobion](https://avatars.githubusercontent.com/u/610090?v=4)](https://github.com/Tobion "Tobion (4 commits)")[![mms-uret](https://avatars.githubusercontent.com/u/900354?v=4)](https://github.com/mms-uret "mms-uret (4 commits)")[![jeanmonod](https://avatars.githubusercontent.com/u/114489?v=4)](https://github.com/jeanmonod "jeanmonod (2 commits)")[![michellesanver](https://avatars.githubusercontent.com/u/570982?v=4)](https://github.com/michellesanver "michellesanver (2 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

---

Tags

rokkarokka.io

###  Code Quality

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/rokka-client-cli/health.svg)

```
[![Health](https://phpackages.com/badges/rokka-client-cli/health.svg)](https://phpackages.com/packages/rokka-client-cli)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[simplesamlphp/simplesamlphp

A PHP implementation of a SAML 2.0 service provider and identity provider.

1.1k12.4M193](/packages/simplesamlphp-simplesamlphp)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[crunzphp/crunz

Schedule your tasks right from the code.

2292.0M6](/packages/crunzphp-crunz)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
