PHPackages                             oxidprojects/oxrun - 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. oxidprojects/oxrun

ActiveOxideshop-component[CLI &amp; Console](/categories/cli)

oxidprojects/oxrun
==================

Oxrun provides a cli toolset for the OXID eShop v6.x

5.1.4(2y ago)920.0k↑38.5%7[3 issues](https://github.com/OXIDprojects/oxrun/issues)[1 PRs](https://github.com/OXIDprojects/oxrun/pulls)MITPHP

Since Mar 28Pushed 1y ago7 watchersCompare

[ Source](https://github.com/OXIDprojects/oxrun)[ Packagist](https://packagist.org/packages/oxidprojects/oxrun)[ Docs](https://github.com/oxidprojects/oxrun)[ RSS](/packages/oxidprojects-oxrun/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (8)Versions (26)Used By (0)

Oxrun
=====

[](#oxrun)

[![oxrun ci](https://github.com/OXIDprojects/oxrun/actions/workflows/oxrun.yml/badge.svg?branch=master)](https://github.com/OXIDprojects/oxrun/actions/workflows/oxrun.yml)[![Coverage Status](https://camo.githubusercontent.com/37633a442f4031b48dbf44b379622882835a9bb9f49e37d35b28acacd2ff88c4/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f4f58494470726f6a656374732f6f7872756e2f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/OXIDprojects/oxrun?branch=master)

Oxrun provides a cli toolset for the OXID eShop Community Edition.

Documentation
=============

[](#documentation)

- [Fully Documentation](http://oxidprojects.github.io/oxrun/)
- Documentation for [contributing](README_DEV.md)
- [Changelog](READY_CONVERED_TO_v6.2.md) of command between v4.x to v5.x

Installation
------------

[](#installation)

`composer require oxidprojects/oxrun`.

- PHP &gt;=7.1 is required.
- OXID eShop &gt;= CE v6.5 is required.

After installation manually clear the cache via `./vendor/bin/oxrun-light cache:clear` to make all oxrun commands available.

Usage
=====

[](#usage)

`./vendor/bin/oe-console` is standard call.

- `./vendor/bin/oxrun-light` is a light version of tools that are not need an active OXID eSale database connection.
- `./vendor/bin/oxrun` is a alias from `oe-console`

---

- Copyright (c) 2021 Tobias Matthaiou
- Copyright (c) 2018 Stefan Moises
- Copyright (c) 2015 Marc Harding  ()

Available commands
==================

[](#available-commands)

##### cache

[](#cache)

- [cache:clear](#cacheclear) Clear OXID cache

##### config

[](#config)

- [config:get](#configget) Gets a config value
- [config:multiset](#configmultiset)
- [config:set](#configset) Sets a config value
- [config:shop:get](#configshopget) Gets a shop config value
- [config:shop:set](#configshopset) Sets a shop config value

##### db

[](#db)

- [db:anonymize](#dbanonymize) Anonymize relevant OXID db tables
- [db:dump](#dbdump) Create a dump, with mysqldump
- [db:import](#dbimport) Import a sql file
- [db:info](#dbinfo) Show a Table with size of all Tables
- [db:list](#dblist) List of all Tables
- [db:query](#dbquery) Executes a query

##### deploy

[](#deploy)

- [deploy:config](#deployconfig) Sets multiple configuration values that are not in module settings
- [deploy:generate:configuration](#deploygenerateconfiguration) Generate a yaml with configuration from Database. For command `deploy:config`
- [deploy:generate:module-activator](#deploygeneratemodule-activator) Generate a yaml file for command `deploy:module-activator`
- [deploy:link:environment](#deploylinkenvironment) Links the environment configration files. Ideal for CI/CD
- [deploy:module-activator](#deploymodule-activator) Activates multiple modules, based on a YAML file
- [deploy:module-apply-configuration-light](#deploymodule-apply-configuration-light) It the same as `oe:module:apply-configuration` but faster.
- [deploy:update-module-config](#deployupdate-module-config) Update the module configuration yaml with the data from the database

##### misc

[](#misc)

- [misc:generate:yaml:config](#miscgenerateyamlconfig)
- [misc:generate:yaml:module](#miscgenerateyamlmodule)
- [misc:phpstorm:metadata](#miscphpstormmetadata) Generate a PhpStorm metadata file for auto-completion and a oxid module chain.Ideal for psalm or phpstan
- [misc:register:command](#miscregistercommand) Extends the service.yaml file with the commands. So that they are found in oe-console.

##### module

[](#module)

- [module:generate](#modulegenerate) Generates a module skeleton
- [module:list](#modulelist) Lists all modules
- [module:multiactivator](#modulemultiactivator)
- [module:reload](#modulereload) Deactivate and activate a module

##### oxid

[](#oxid)

- [oxid:shops](#oxidshops) Lists the shops

##### route

[](#route)

- [route:debug](#routedebug) Returns the route. Which controller and parameters are called.

##### user

[](#user)

- [user:create](#usercreate) Creates a new user
- [user:password](#userpassword) Sets a new password

##### views

[](#views)

- [views:update](#viewsupdate) Updates the views

`cache:clear`
-------------

[](#cacheclear)

Clear OXID cache

### Usage

[](#usage-1)

- `cache:clear [-f|--force]`

Clear OXID cache

### Options

[](#options)

#### `--force|-f`

[](#--force-f)

Try to delete the cache anyway. \[danger or permission denied\]

- Accept value: no
- Is value required: no
- Default: `false`

`config:get`
------------

[](#configget)

Gets a config value

### Usage

[](#usage-2)

- `config:get [--moduleId [MODULEID]] [--json] [--yaml] [--] `

Gets a config value

### Arguments

[](#arguments)

#### `variableName`

[](#variablename)

Variable name

### Options

[](#options-1)

#### `--moduleId`

[](#--moduleid)

- Is value required: no
- Default: `''`

#### `--json`

[](#--json)

Output as json

- Accept value: no
- Is value required: no
- Default: `false`

#### `--yaml`

[](#--yaml)

Output as YAML (default)

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:config`
---------------

[](#deployconfig)

Sets multiple configuration values that are not in module settings

### Usage

[](#usage-3)

- `deploy:config [-f|--force-db] [--production] [--staging] [--development] [--testing] [--] `
- `config:multiset`

This command can import settings into the database that are not found in the module settings. If they are module settings, they are stored in the module configuration yaml, not in the database.

The file path is relative to the shop installation\_root\_path/var/oxrun\_config/. You can also pass a YAML string on the command line.

To create YAML use command `oe-console deploy:generate:configration --help`

YAML example:

```
environment:
  - "production"
  - "staging"
  - "development"
  - "testing"
config:
  1:
    blReverseProxyActive:
      variableType: bool
      variableValue: false
    sMallShopURL: http://myshop.dev.local
    sMallSSLShopURL: http://myshop.dev.local
  2:
    blReverseProxyActive:
    ...
```

[Example: malls.yml.dist](example/malls.yml.dist)

If you want, you can also specify **a YAML string on the command line instead of a file**, e.g.:

```
../vendor/bin/oe-console deploy:config $'config:
  1:
    foobar: barfoo
' --shop-id=1
```

### Arguments

[](#arguments-1)

#### `configfile`

[](#configfile)

The file containing the config values, see example/malls.yml.dist. (e.g. dev.yml, stage.yml, prod.yml)

### Options

[](#options-2)

#### `--force-db|-f`

[](#--force-db-f)

Still write everything into the database.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--production`

[](#--production)

For "production" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--staging`

[](#--staging)

For "staging" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--development`

[](#--development)

For "development" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--testing`

[](#--testing)

For "testing" system

- Accept value: no
- Is value required: no
- Default: `false`

`config:set`
------------

[](#configset)

Sets a config value

### Usage

[](#usage-4)

- `config:set [--variableType VARIABLETYPE] [--moduleId [MODULEID]] [--]  `

Sets a config value

### Arguments

[](#arguments-2)

#### `variableName`

[](#variablename-1)

Variable name

#### `variableValue`

[](#variablevalue)

Variable value

### Options

[](#options-3)

#### `--variableType`

[](#--variabletype)

Variable type

- Is value required: yes

#### `--moduleId`

[](#--moduleid-1)

- Is value required: no

`config:shop:get`
-----------------

[](#configshopget)

Gets a shop config value

### Usage

[](#usage-5)

- `config:shop:get `

Gets a shop config value

### Arguments

[](#arguments-3)

#### `variableName`

[](#variablename-2)

Variable name

`config:shop:set`
-----------------

[](#configshopset)

Sets a shop config value

### Usage

[](#usage-6)

- `config:shop:set  `

Sets a shop config value

### Arguments

[](#arguments-4)

#### `variableName`

[](#variablename-3)

Variable name

#### `variableValue`

[](#variablevalue-1)

Variable value

`db:anonymize`
--------------

[](#dbanonymize)

Anonymize relevant OXID db tables

### Usage

[](#usage-7)

- `db:anonymize [--debug] [-d|--domain [DOMAIN]] [-k|--keepdomain [KEEPDOMAIN]]`

Anonymizes user relevant data in the OXID database. Relevant tables are: Array ( \[0\] =&gt; oxnewssubscribed \[1\] =&gt; oxuser \[2\] =&gt; oxvouchers \[3\] =&gt; oxaddress \[4\] =&gt; oxorder )

### Options

[](#options-4)

#### `--debug`

[](#--debug)

Debug SQL queries generated

- Accept value: no
- Is value required: no
- Default: `false`

#### `--domain|-d`

[](#--domain-d)

Domain to use for all anonymized usernames /email addresses, default is "@oxrun.com"

- Is value required: no

#### `--keepdomain|-k`

[](#--keepdomain-k)

Domain which should NOT be anonymized, default is "@foobar.com". Data with this domain in the email address will NOT be anonymized.

- Is value required: no

`db:dump`
---------

[](#dbdump)

Create a dump, with mysqldump

### Usage

[](#usage-8)

- `db:dump [--file FILE] [-t|--table TABLE] [-i|--ignoreViews] [-a|--anonymous] [-w|--withoutTableData WITHOUTTABLEDATA]`

Create a dump from the current database.

usage:

```
oe-console db:dump --withoutTableData oxseo,oxvou%
- To dump all Tables, but `oxseo`, `oxvoucher`, and `oxvoucherseries` without data.
  possibilities: oxseo%,oxuser,%logs%

oe-console db:dump --table %user%
- to dump only those tables `oxuser` `oxuserbasketitems` `oxuserbaskets` `oxuserpayments`

oe-console db:dump --anonymous # Perfect for Stage Server
- Those table without data: `oxseo`, `oxseologs`, `oxseohistory`, `oxuser`, `oxuserbasketitems`, `oxuserbaskets`, `oxuserpayments`, `oxnewssubscribed`, `oxremark`, `oxvouchers`, `oxvoucherseries`, `oxaddress`, `oxorder`, `oxorderarticles`, `oxorderfiles`, `oepaypal_order`, `oepaypal_orderpayments`.

oe-console db:dump -v
- With verbose mode you will see the mysqldump command
  (`mysqldump -u 'root' -h 'oxid_db' -p ... `)

oe-console db:dump --file dump.sql
- Put the Output into a File

```

\*\* Only existing tables will be exported. No matter what was required.

System requirement:
-------------------

[](#system-requirement)

```
* php
* MySQL CLI tools.

```

### Options

[](#options-5)

#### `--file`

[](#--file)

Save dump at this location.

- Is value required: yes

#### `--table|-t`

[](#--table-t)

Only names of tables are dumped. Default all tables. Use comma separated list and or pattern e.g. %voucher%

- Is value required: yes

#### `--ignoreViews|-i`

[](#--ignoreviews-i)

Ignore views

- Accept value: no
- Is value required: no
- Default: `false`

#### `--anonymous|-a`

[](#--anonymous-a)

Export not table with person related data.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--withoutTableData|-w`

[](#--withouttabledata-w)

Export tables only with their CREATE statement. So without content. Use comma separated list and or pattern e.g. %voucher%

- Is value required: yes

`db:import`
-----------

[](#dbimport)

Import a sql file

### Usage

[](#usage-9)

- `db:import `

Imports an SQL file on the current shop database.

Requires php exec and MySQL CLI tools installed on your system.

### Arguments

[](#arguments-5)

#### `file`

[](#file)

The sql file which is to be imported

`db:info`
---------

[](#dbinfo)

Show a Table with size of all Tables

### Usage

[](#usage-10)

- `db:info [--tableSize] [--databaseSize]`

Show a Table with size of all Tables

### Options

[](#options-6)

#### `--tableSize`

[](#--tablesize)

Size of all Tables

- Accept value: no
- Is value required: no
- Default: `false`

#### `--databaseSize`

[](#--databasesize)

Size of the Databases

- Accept value: no
- Is value required: no
- Default: `false`

`db:list`
---------

[](#dblist)

List of all Tables

### Usage

[](#usage-11)

- `db:list [-p|--plain] [-t|--pattern PATTERN]`

List Tables

usage: oe-console db:list --pattern oxseo%,oxuser - To dump all Tables, but `oxseo`, `oxvoucher`, and `oxvoucherseries` without data. possibilities: oxseo%,oxuser,%logs%

### Options

[](#options-7)

#### `--plain|-p`

[](#--plain-p)

print list as comma separated.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--pattern|-t`

[](#--pattern-t)

table name pattern test. e.g. oxseo%,oxuser

- Is value required: yes

`db:query`
----------

[](#dbquery)

Executes a query

### Usage

[](#usage-12)

- `db:query [--raw] [--] `

Executes an SQL query on the current shop database. Wrap your SQL in quotes.

If your query produces a result (e.g. a SELECT statement), the output will be returned via the table component. Add the raw option for raw output.

Requires php exec and MySQL CLI tools installed on your system.

### Arguments

[](#arguments-6)

#### `query`

[](#query)

The query which is to be executed

### Options

[](#options-8)

#### `--raw`

[](#--raw)

Raw output

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:config`
---------------

[](#deployconfig-1)

Sets multiple configuration values that are not in module settings

### Usage

[](#usage-13)

- `deploy:config [-f|--force-db] [--production] [--staging] [--development] [--testing] [--] `
- `config:multiset`

This command can import settings into the database that are not found in the module settings. If they are module settings, they are stored in the module configuration yaml, not in the database.

The file path is relative to the shop installation\_root\_path/var/oxrun\_config/. You can also pass a YAML string on the command line.

To create YAML use command `oe-console deploy:generate:configration --help`

YAML example:

```
environment:
  - "production"
  - "staging"
  - "development"
  - "testing"
config:
  1:
    blReverseProxyActive:
      variableType: bool
      variableValue: false
    sMallShopURL: http://myshop.dev.local
    sMallSSLShopURL: http://myshop.dev.local
  2:
    blReverseProxyActive:
    ...
```

[Example: malls.yml.dist](example/malls.yml.dist)

If you want, you can also specify **a YAML string on the command line instead of a file**, e.g.:

```
../vendor/bin/oe-console deploy:config $'config:
  1:
    foobar: barfoo
' --shop-id=1
```

### Arguments

[](#arguments-7)

#### `configfile`

[](#configfile-1)

The file containing the config values, see example/malls.yml.dist. (e.g. dev.yml, stage.yml, prod.yml)

### Options

[](#options-9)

#### `--force-db|-f`

[](#--force-db-f-1)

Still write everything into the database.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--production`

[](#--production-1)

For "production" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--staging`

[](#--staging-1)

For "staging" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--development`

[](#--development-1)

For "development" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--testing`

[](#--testing-1)

For "testing" system

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:generate:configuration`
-------------------------------

[](#deploygenerateconfiguration)

Generate a yaml with configuration from Database. For command `deploy:config`

### Usage

[](#usage-14)

- `deploy:generate:configuration [-u|--update] [-c|--configfile CONFIGFILE] [--oxvarname OXVARNAME] [--oxmodule OXMODULE] [-d|--no-descriptions] [-l|--language LANGUAGE] [--list] [--production] [--staging] [--development] [--testing]`
- `misc:generate:yaml:config`

Configration that is not included in the modules can be saved. With the command: deploy:config they can be read again

### Options

[](#options-10)

#### `--update|-u`

[](#--update-u)

Update an exited config file, with data from DB

- Accept value: no
- Is value required: no
- Default: `false`

#### `--configfile|-c`

[](#--configfile-c)

The config file to update or create if not exits

- Is value required: yes
- Default: `'dev_config.yml'`

#### `--oxvarname`

[](#--oxvarname)

Dump configs by oxvarname. One name or as comma separated List

- Is value required: yes

#### `--oxmodule`

[](#--oxmodule)

Dump configs by oxmodule. One name or as comma separated List

- Is value required: yes

#### `--no-descriptions|-d`

[](#--no-descriptions-d)

No descriptions are added.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--language|-l`

[](#--language-l)

Speech selection of the descriptions.

- Is value required: yes
- Default: `0`

#### `--list`

[](#--list)

list all saved configrationen

- Accept value: no
- Is value required: no
- Default: `false`

#### `--production`

[](#--production-2)

For "production" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--staging`

[](#--staging-2)

For "staging" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--development`

[](#--development-2)

For "development" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--testing`

[](#--testing-2)

For "testing" system

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:generate:module-activator`
----------------------------------

[](#deploygeneratemodule-activator)

Generate a yaml file for command `deploy:module-activator`

### Usage

[](#usage-15)

- `deploy:generate:module-activator [-c|--configfile CONFIGFILE] [-w|--whitelist] [-b|--blacklist]`
- `misc:generate:yaml:module`

Generate a yaml file for command `deploy:module-activator`

### Options

[](#options-11)

#### `--configfile|-c`

[](#--configfile-c-1)

The Config file to change or create if not exits

- Is value required: yes
- Default: `'dev_module.yml'`

#### `--whitelist|-w`

[](#--whitelist-w)

Takes modules that are always activated. All others remain deactive.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--blacklist|-b`

[](#--blacklist-b)

Takes modules that always need to be disabled. All others are activated.

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:link:environment`
-------------------------

[](#deploylinkenvironment)

Links the environment configration files. Ideal for CI/CD

### Usage

[](#usage-16)

- `deploy:link:environment [--rm] [--production] [--staging] [--development] [--testing]`

In files structure you has multiple files per shop in var/configuration/environment directory. e.g. production.1.yaml, staging.1.yaml This might be useful when deploying files to some specific environment. @see: [Modules configuration deployment](https://docs.oxid-esales.com/developer/en/6.2/development/modules_components_themes/project/module_configuration/modules_configuration_deployment.html#dealing-with-environment-files)

### Options

[](#options-12)

#### `--rm`

[](#--rm)

Remove the links

- Accept value: no
- Is value required: no
- Default: `false`

#### `--production`

[](#--production-3)

For "production" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--staging`

[](#--staging-3)

For "staging" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--development`

[](#--development-3)

For "development" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--testing`

[](#--testing-3)

For "testing" system

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:module-activator`
-------------------------

[](#deploymodule-activator)

Activates multiple modules, based on a YAML file

### Usage

[](#usage-17)

- `deploy:module-activator [-s|--skipDeactivation] [-d|--clearModuleData] [--] `
- `module:multiactivator`

usage: oe-console deploy:module-activator modules.yml

- to activate all modules defined in the YAML file based on a white- or blacklist

Example:

```
whitelist:
  1:
    - ocb_cleartmp
    - moduleinternals
   #- ddoevisualcms
   #- ddoewysiwyg
  2:
    - ocb_cleartmp
priorities:
  1:
    moduleinternals:
      1200
   ocb_cleartmp:
      950
```

Supports either a **"whitelist"** and or a **"blacklist"** entry with multiple shop ids and the desired module ids to activate (whitelist) or to exclude from activation (blacklist).

With "priorities", you can define the order (per subshop) in which the modules will be activated.

If you want, you can also specify **a YAML string on the command line instead of a file**, e.g.:

```
oe-console deploy:module-activator $'whitelist:
  1:
    - oepaypal
' --shop-id=1
```

### Arguments

[](#arguments-8)

#### `yaml`

[](#yaml)

YAML module list filename or YAML string. The file path is relative to /var/www/oxid-esale/var/oxrun\_config/

### Options

[](#options-13)

#### `--skipDeactivation|-s`

[](#--skipdeactivation-s)

Skip deactivation of modules, only activate.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--clearModuleData|-d`

[](#--clearmoduledata-d)

Clear module data in oxconfig.

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:module-apply-configuration-light`
-----------------------------------------

[](#deploymodule-apply-configuration-light)

It the same as `oe:module:apply-configuration` but faster.

### Usage

[](#usage-18)

- `deploy:module-apply-configuration-light`

The module configurations will ONLY written into the database.

- Without deactivating or activating the modules
- Without rewrite module configration yaml's

WARNING: If you make changes on metadata.php::controllers|::extend then this command doesn't work.

That automatic activate or deactive module with the param `configured: true|false`. It the same as `oe:module:apply-configuration` but faster!

`deploy:update-module-config`
-----------------------------

[](#deployupdate-module-config)

Update the module configuration yaml with the data from the database

### Usage

[](#usage-19)

- `deploy:update-module-config [--production] [--staging] [--development] [--testing]`

Is the reverse command from `oe:module:apply-configuration`.

### Options

[](#options-14)

#### `--production`

[](#--production-4)

For "production" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--staging`

[](#--staging-4)

For "staging" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--development`

[](#--development-4)

For "development" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--testing`

[](#--testing-4)

For "testing" system

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:generate:configuration`
-------------------------------

[](#deploygenerateconfiguration-1)

Generate a yaml with configuration from Database. For command `deploy:config`

### Usage

[](#usage-20)

- `deploy:generate:configuration [-u|--update] [-c|--configfile CONFIGFILE] [--oxvarname OXVARNAME] [--oxmodule OXMODULE] [-d|--no-descriptions] [-l|--language LANGUAGE] [--list] [--production] [--staging] [--development] [--testing]`
- `misc:generate:yaml:config`

Configration that is not included in the modules can be saved. With the command: deploy:config they can be read again

### Options

[](#options-15)

#### `--update|-u`

[](#--update-u-1)

Update an exited config file, with data from DB

- Accept value: no
- Is value required: no
- Default: `false`

#### `--configfile|-c`

[](#--configfile-c-2)

The config file to update or create if not exits

- Is value required: yes
- Default: `'dev_config.yml'`

#### `--oxvarname`

[](#--oxvarname-1)

Dump configs by oxvarname. One name or as comma separated List

- Is value required: yes

#### `--oxmodule`

[](#--oxmodule-1)

Dump configs by oxmodule. One name or as comma separated List

- Is value required: yes

#### `--no-descriptions|-d`

[](#--no-descriptions-d-1)

No descriptions are added.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--language|-l`

[](#--language-l-1)

Speech selection of the descriptions.

- Is value required: yes
- Default: `0`

#### `--list`

[](#--list-1)

list all saved configrationen

- Accept value: no
- Is value required: no
- Default: `false`

#### `--production`

[](#--production-5)

For "production" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--staging`

[](#--staging-5)

For "staging" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--development`

[](#--development-5)

For "development" system

- Accept value: no
- Is value required: no
- Default: `false`

#### `--testing`

[](#--testing-5)

For "testing" system

- Accept value: no
- Is value required: no
- Default: `false`

`deploy:generate:module-activator`
----------------------------------

[](#deploygeneratemodule-activator-1)

Generate a yaml file for command `deploy:module-activator`

### Usage

[](#usage-21)

- `deploy:generate:module-activator [-c|--configfile CONFIGFILE] [-w|--whitelist] [-b|--blacklist]`
- `misc:generate:yaml:module`

Generate a yaml file for command `deploy:module-activator`

### Options

[](#options-16)

#### `--configfile|-c`

[](#--configfile-c-3)

The Config file to change or create if not exits

- Is value required: yes
- Default: `'dev_module.yml'`

#### `--whitelist|-w`

[](#--whitelist-w-1)

Takes modules that are always activated. All others remain deactive.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--blacklist|-b`

[](#--blacklist-b-1)

Takes modules that always need to be disabled. All others are activated.

- Accept value: no
- Is value required: no
- Default: `false`

`misc:phpstorm:metadata`
------------------------

[](#miscphpstormmetadata)

Generate a PhpStorm metadata file for auto-completion and a oxid module chain.Ideal for psalm or phpstan

### Usage

[](#usage-22)

- `misc:phpstorm:metadata [-o|--output-dir OUTPUT-DIR]`

Generate a PhpStorm metadata file for auto-completion and a oxid module chain.Ideal for psalm or phpstan

### Options

[](#options-17)

#### `--output-dir|-o`

[](#--output-dir-o)

Writes the metadata for PhpStorm to the specified directory.

- Is value required: yes

`misc:register:command`
-----------------------

[](#miscregistercommand)

Extends the service.yaml file with the commands. So that they are found in oe-console.

### Usage

[](#usage-23)

- `misc:register:command [--isModule] [-s|--service-yaml SERVICE-YAML] [-y|--yaml-inline YAML-INLINE] [--] `

Extends the service.yaml file with the commands. So that they are found in oe-console.

### Arguments

[](#arguments-9)

#### `command-dir`

[](#command-dir)

The folder where the commands are located or Module with option --isModule

### Options

[](#options-18)

#### `--isModule`

[](#--ismodule)

Just write the Module and the path and the service-yaml will be found automatically.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--service-yaml|-s`

[](#--service-yaml-s)

The service.yaml file that will be updated (default: var/configuration/configurable\_services.yaml)

- Is value required: yes

#### `--yaml-inline|-y`

[](#--yaml-inline-y)

The level where you switch to inline YAML

- Is value required: yes
- Default: `4`

`module:generate`
-----------------

[](#modulegenerate)

Generates a module skeleton

### Usage

[](#usage-24)

- `module:generate [-s|--skeleton SKELETON] [--name NAME] [--vendor VENDOR] [--description DESCRIPTION] [--author AUTHOR] [--email EMAIL]`

Generates a module skeleton

### Options

[](#options-19)

#### `--skeleton|-s`

[](#--skeleton-s)

Zip of a Oxid Module Skeleton

- Is value required: yes
- Default: `'https://github.com/OXIDprojects/oxid-module-skeleton/archive/v6_module.zip'`

#### `--name`

[](#--name)

Module name

- Is value required: yes

#### `--vendor`

[](#--vendor)

Vendor

- Is value required: yes

#### `--description`

[](#--description)

Description of your Module: OXID eShop Module ...

- Is value required: yes

#### `--author`

[](#--author)

Author of Module

- Is value required: yes

#### `--email`

[](#--email)

Email of Author

- Is value required: yes

`module:list`
-------------

[](#modulelist)

Lists all modules

### Usage

[](#usage-25)

- `module:list`

Lists all modules

`deploy:module-activator`
-------------------------

[](#deploymodule-activator-1)

Activates multiple modules, based on a YAML file

### Usage

[](#usage-26)

- `deploy:module-activator [-s|--skipDeactivation] [-d|--clearModuleData] [--] `
- `module:multiactivator`

usage: oe-console deploy:module-activator modules.yml

- to activate all modules defined in the YAML file based on a white- or blacklist

Example:

```
whitelist:
  1:
    - ocb_cleartmp
    - moduleinternals
   #- ddoevisualcms
   #- ddoewysiwyg
  2:
    - ocb_cleartmp
priorities:
  1:
    moduleinternals:
      1200
   ocb_cleartmp:
      950
```

Supports either a **"whitelist"** and or a **"blacklist"** entry with multiple shop ids and the desired module ids to activate (whitelist) or to exclude from activation (blacklist).

With "priorities", you can define the order (per subshop) in which the modules will be activated.

If you want, you can also specify **a YAML string on the command line instead of a file**, e.g.:

```
oe-console deploy:module-activator $'whitelist:
  1:
    - oepaypal
' --shop-id=1
```

### Arguments

[](#arguments-10)

#### `yaml`

[](#yaml-1)

YAML module list filename or YAML string. The file path is relative to /var/www/oxid-esale/var/oxrun\_config/

### Options

[](#options-20)

#### `--skipDeactivation|-s`

[](#--skipdeactivation-s-1)

Skip deactivation of modules, only activate.

- Accept value: no
- Is value required: no
- Default: `false`

#### `--clearModuleData|-d`

[](#--clearmoduledata-d-1)

Clear module data in oxconfig.

- Accept value: no
- Is value required: no
- Default: `false`

`module:reload`
---------------

[](#modulereload)

Deactivate and activate a module

### Usage

[](#usage-27)

- `module:reload [-f|--force-cache] [-s|--skip-cache-clear] [-c|--based-on-config BASED-ON-CONFIG] [--] `

Deactivate and activate a module

### Arguments

[](#arguments-11)

#### `module`

[](#module-1)

Module name

### Options

[](#options-21)

#### `--force-cache|-f`

[](#--force-cache-f)

cache:clear with --force option

- Accept value: no
- Is value required: no
- Default: `false`

#### `--skip-cache-clear|-s`

[](#--skip-cache-clear-s)

skip cache:clear command

- Accept value: no
- Is value required: no
- Default: `false`

#### `--based-on-config|-c`

[](#--based-on-config-c)

Checks if module is allowed to be reloaded based on the deploy:module-activator yaml file.

- Is value required: yes

`oxid:shops`
------------

[](#oxidshops)

Lists the shops

### Usage

[](#usage-28)

- `oxid:shops [-i|--only-ids]`

Lists the shops

### Options

[](#options-22)

#### `--only-ids|-i`

[](#--only-ids-i)

show only Shop id's. eg. "oe-console oxid:shops --only-ids | xargs -tn1 oe-console ... --shop-id "

- Accept value: no
- Is value required: no
- Default: `false`

`route:debug`
-------------

[](#routedebug)

Returns the route. Which controller and parameters are called.

### Usage

[](#usage-29)

- `route:debug [-c|--copy] [--] `

Returns the route. Which controller and parameters are called.

### Arguments

[](#arguments-12)

#### `url`

[](#url)

Website URL. Full or Path

### Options

[](#options-23)

#### `--copy|-c`

[](#--copy-c)

Copy file path from the class to the clipboard (only MacOS)

- Accept value: no
- Is value required: no
- Default: `false`

`user:create`
-------------

[](#usercreate)

Creates a new user

### Usage

[](#usage-30)

- `user:create`

Creates a new user

`user:password`
---------------

[](#userpassword)

Sets a new password

### Usage

[](#usage-31)

- `user:password  `

Sets a new password

### Arguments

[](#arguments-13)

#### `username`

[](#username)

Username

#### `password`

[](#password)

New password

`views:update`
--------------

[](#viewsupdate)

Updates the views

### Usage

[](#usage-32)

- `views:update`

Updates the views

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance23

Infrequent updates — may be unmaintained

Popularity33

Limited adoption so far

Community22

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor1

Top contributor holds 64.9% of commits — single point of failure

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 ~87 days

Recently: every ~164 days

Total

23

Last Release

1002d ago

Major Versions

1.9.1 → 2.0.02018-03-28

2.0.0 → 3.0.02018-11-13

3.3.0 → 4.0.02019-03-24

4.3.2 → 5.0.0-RC172021-08-17

### Community

Maintainers

![](https://www.gravatar.com/avatar/08ef539c93c95c0ccb3c36d51c8cc86a6276e8e5a8fb3fadd983843b013dbba3?d=identicon)[TumTum](/maintainers/TumTum)

---

Top Contributors

[![TumTum](https://avatars.githubusercontent.com/u/225997?v=4)](https://github.com/TumTum "TumTum (279 commits)")[![marcharding](https://avatars.githubusercontent.com/u/3768?v=4)](https://github.com/marcharding "marcharding (83 commits)")[![tmloberon](https://avatars.githubusercontent.com/u/28302826?v=4)](https://github.com/tmloberon "tmloberon (32 commits)")[![smxsm](https://avatars.githubusercontent.com/u/1737182?v=4)](https://github.com/smxsm "smxsm (21 commits)")[![keywan-ghadami-oxid](https://avatars.githubusercontent.com/u/7767623?v=4)](https://github.com/keywan-ghadami-oxid "keywan-ghadami-oxid (7 commits)")[![kermie](https://avatars.githubusercontent.com/u/1337898?v=4)](https://github.com/kermie "kermie (2 commits)")[![proudcommerce](https://avatars.githubusercontent.com/u/4111533?v=4)](https://github.com/proudcommerce "proudcommerce (1 commits)")[![icedream](https://avatars.githubusercontent.com/u/807772?v=4)](https://github.com/icedream "icedream (1 commits)")[![DanielRuf](https://avatars.githubusercontent.com/u/827205?v=4)](https://github.com/DanielRuf "DanielRuf (1 commits)")[![makkus183](https://avatars.githubusercontent.com/u/2034761?v=4)](https://github.com/makkus183 "makkus183 (1 commits)")[![adriankirchner](https://avatars.githubusercontent.com/u/149483?v=4)](https://github.com/adriankirchner "adriankirchner (1 commits)")[![markus-schall](https://avatars.githubusercontent.com/u/57865774?v=4)](https://github.com/markus-schall "markus-schall (1 commits)")

---

Tags

cliOXIDeshopoe-consolepimp

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/oxidprojects-oxrun/health.svg)

```
[![Health](https://phpackages.com/badges/oxidprojects-oxrun/health.svg)](https://phpackages.com/packages/oxidprojects-oxrun)
```

###  Alternatives

[pantheon-systems/terminus

A command line interface for Pantheon

3411.4M10](/packages/pantheon-systems-terminus)[acmephp/acmephp

Let's Encrypt client written in PHP

649153.6k](/packages/acmephp-acmephp)[mehrancodes/laravel-harbor

A CLI tool to Quickly create On-Demand preview environment for your apps.

9985.2k](/packages/mehrancodes-laravel-harbor)[getkirby/cli

Kirby command line interface

6064.5k24](/packages/getkirby-cli)[php-school/php-workshop

PHP Workshop Framework

466.3k5](/packages/php-school-php-workshop)

PHPackages © 2026

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