PHPackages                             marcharding/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 & Console](/categories/cli)
4. /
5. marcharding/oxrun

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

marcharding/oxrun
=================

Oxrun provides a cli toolset for the OXID eShop Community Edition

2.0.0(8y ago)103919[2 PRs](https://github.com/marcharding/oxrun/pulls)MITPHP

Since Mar 28Pushed 6y ago4 watchersCompare

[ Source](https://github.com/marcharding/oxrun)[ Packagist](https://packagist.org/packages/marcharding/oxrun)[ Docs](https://github.com/marcharding/oxrun)[ RSS](/packages/marcharding-oxrun/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (8)Versions (3)Used By (0)

Oxrun
=====

[](#oxrun)

[![Build Status](https://camo.githubusercontent.com/ebef51da252295f1aef0b19cce73900bc8856884acb765cf46090ad73265c187/68747470733a2f2f7472617669732d63692e6f72672f6d61726368617264696e672f6f7872756e2e737667)](https://travis-ci.org/marcharding/oxrun)[![Coverage Status](https://camo.githubusercontent.com/587822354f2c2a3af2cfd18426d612db1687390bd343f900732e47fb77f4166e/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6d61726368617264696e672f6f7872756e2f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/marcharding/oxrun?branch=master)

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

Thanks to the [netz98 magerun](https://github.com/netz98/n98-magerun) project which heavily inspired oxrun.

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

[](#installation)

PHP 5.6 is required.

If you are using composer (which you probably are), just add `"marcharding/oxrun": "dev-master"` to your composer.json and run composer install.

You can then use oxrun by calling `vendor/bin/oxrun` or add `vendor/bin` to your $PATH to be able to just call `oxrun`.

You can also install oxrun by simply downloading the phar file from the release tab.

Here is a bash snippet which automatically downloads the latest release from github:

```
curl -LOk `curl --silent https://api.github.com/repos/marcharding/oxrun/releases/latest | awk '/browser_download_url/ { print $2 }' | sed 's/"//g'`

```

You can oxrun now via `php oxrun.phar`

Alternatively you can also make the phar itself executable and copy it to your /usr/local/bin/ directory for global usage.

```
chmod +x oxrun.phar
sudo mv oxrun.phar /usr/local/bin/oxrun

```

You can then run oxrun by just calling `oxrun`

Usage
=====

[](#usage)

To use oxrun just execute `php oxrun.phar` or `oxrun` (see above).

Execute oxrun inside your OXID eShop base directory (or subdirectory) if you want to interact with an existing shop. It will automatically try to find the oxid boostrap.php and load it.

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

[](#available-commands)

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

[](#cacheclear)

- Description: Clears the cache
- Usage: `cache:clear`

### Options:

[](#options)

cms:update
----------

[](#cmsupdate)

- Description: Updates a cms page
- Usage: `cms:update [--title[="..."]] [--content[="..."]] [--language="..."] [--active="..."] ident`

### Arguments:

[](#arguments)

**ident:**

- Name: ident
- Description: Content ident

### Options:

[](#options-1)

**title:**

- Name: `--title`
- Is value required: no
- Description: Content title

**content:**

- Name: `--content`
- Is value required: no
- Description: Content body

**language:**

- Name: `--language`
- Is value required: yes
- Description: Content language

**active:**

- Name: `--active`
- Is value required: yes
- Description: Content active

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

[](#configget)

- Description: Gets a config value
- Usage: `config:get [--shopId[="..."]] [--moduleId[="..."]] variableName`

### Arguments:

[](#arguments-1)

**variableName:**

- Name: variableName
- Description: Variable name

### Options:

[](#options-2)

**shopId:**

- Name: `--shopId`
- Is value required: no
- Description:

**moduleId:**

- Name: `--moduleId`
- Is value required: no
- Description:

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

[](#configset)

- Description: Sets a config value
- Usage: `config:set [--variableType="..."] [--shopId[="..."]] [--moduleId[="..."]] variableName variableValue`

### Arguments:

[](#arguments-2)

**variableName:**

- Name: variableName
- Description: Variable name

**variableValue:**

- Name: variableValue
- Description: Variable value

### Options:

[](#options-3)

**variableType:**

- Name: `--variableType`
- Is value required: yes
- Description: Variable type

**shopId:**

- Name: `--shopId`
- Is value required: no
- Description:

**moduleId:**

- Name: `--moduleId`
- Is value required: no
- Description:

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

[](#configshopget)

- Description: Sets a shop config value
- Usage: `config:shop:get [--shopId[="..."]] variableName`

### Arguments:

[](#arguments-3)

**variableName:**

- Name: variableName
- Description: Variable name

### Options:

[](#options-4)

**shopId:**

- Name: `--shopId`
- Is value required: no
- Description: oxbaseshop
- Default: `'oxbaseshop'`

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

[](#configshopset)

- Description: Sets a shop config value
- Usage: `config:shop:set [--shopId[="..."]] variableName variableValue`

### Arguments:

[](#arguments-4)

**variableName:**

- Name: variableName
- Description: Variable name

**variableValue:**

- Name: variableValue
- Description: Variable value

### Options:

[](#options-5)

**shopId:**

- Name: `--shopId`
- Is value required: no
- Description: oxbaseshop
- Default: `'oxbaseshop'`

db:dump
-------

[](#dbdump)

- Description: Dumps the the current shop database
- Usage: `db:dump [--file="..."]`

Dumps the the current shop database.

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

### Options:

[](#options-6)

**file:**

- Name: `--file`
- Is value required: yes
- Description: Dump sql in to this file

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

[](#dbimport)

- Description: Import a sql file
- Usage: `db:import file`

Imports an SQL file on the current shop database.

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

### Arguments:

[](#arguments-5)

**file:**

- Name: file
- Description: The sql file which is to be imported

### Options:

[](#options-7)

db:query
--------

[](#dbquery)

- Description: Executes a query
- Usage: `db:query [--raw] query`

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:**

- Name: query
- Description: The query which is to be executed

### Options:

[](#options-8)

**raw:**

- Name: `--raw`
- Accept value: no
- Is value required: no
- Description: Raw output
- Default: `false`

install:shop
------------

[](#installshop)

- Description: Installs the shop
- Usage: `install:shop [--oxidVersion[="..."]] [--installationFolder[="..."]] [--dbHost="..."] [--dbUser="..."] [--dbPwd="..."] [--dbName="..."] [--dbPort[="..."]] [--installSampleData[="..."]] [--shopURL="..."] [--adminUser="..."] [--adminPassword="..."]`

### Options:

[](#options-9)

**oxidVersion:**

- Name: `--oxidVersion`
- Is value required: no
- Description: Oxid version
- Default: `'v4.9.5'`

**installationFolder:**

- Name: `--installationFolder`
- Is value required: no
- Description: Installation folder
- Default: `'/vagrant/web/oxrun'`

**dbHost:**

- Name: `--dbHost`
- Is value required: yes
- Description: Database host
- Default: `'localhost'`

**dbUser:**

- Name: `--dbUser`
- Is value required: yes
- Description: Database user
- Default: `'oxid'`

**dbPwd:**

- Name: `--dbPwd`
- Is value required: yes
- Description: Database password
- Default: `''`

**dbName:**

- Name: `--dbName`
- Is value required: yes
- Description: Database name
- Default: `'oxid'`

**dbPort:**

- Name: `--dbPort`
- Is value required: no
- Description: Database port
- Default: `3306`

**installSampleData:**

- Name: `--installSampleData`
- Is value required: no
- Description: Install sample data
- Default: `true`

**shopURL:**

- Name: `--shopURL`
- Is value required: yes
- Description: Installation base url

**adminUser:**

- Name: `--adminUser`
- Is value required: yes
- Description: Admin user email/login

**adminPassword:**

- Name: `--adminPassword`
- Is value required: yes
- Description: Admin password

misc:generate:documentation
---------------------------

[](#miscgeneratedocumentation)

- Description: Generate a raw command documentation of the available commands
- Usage: `misc:generate:documentation`

### Arguments:

[](#arguments-7)

**command:**

- Name: command
- Description: The command to execute

### Options:

[](#options-10)

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

[](#miscphpstormmetadata)

- Description: Generate a PhpStorm metadata file for autocompletion
- Usage: `misc:phpstorm:metadata`

### Options:

[](#options-11)

**output-dir:**

- Name: `--output-dir`, `-o`
- Accept value: yes
- Is value required: yes
- Description: Writes the metadata for PhpStorm to the specified directory.

module:activate
---------------

[](#moduleactivate)

- Description: Activates a module
- Usage: `module:activate module`

### Arguments:

[](#arguments-8)

**module:**

- Name: module
- Description: Module name

### Options:

[](#options-12)

module:deactivate
-----------------

[](#moduledeactivate)

- Description: Deactivates a module
- Usage: `module:deactivate module`

### Arguments:

[](#arguments-9)

**module:**

- Name: module
- Description: Module name

### Options:

[](#options-13)

module:fix
----------

[](#modulefix)

- Description: Fixes a module
- Usage: `module:fix module`

### Arguments:

[](#arguments-10)

**module:**

- Name: module
- Description: Module name

### Options:

[](#options-14)

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

[](#modulegenerate)

- Description: Generates a module skeleton
- Usage: `module:generate module`

### Arguments:

[](#arguments-11)

**module:**

- Name: module
- Description: Module name

### Options:

[](#options-15)

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

[](#modulelist)

- Description: Lists all modules
- Usage: `module:list`

### Options:

[](#options-16)

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

[](#userpassword)

- Description: Sets a new password
- Usage: `user:password username password`

### Arguments:

[](#arguments-12)

**username:**

- Name: username
- Description: Username

**password:**

- Name: password
- Description: New password

### Options:

[](#options-17)

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

[](#viewsupdate)

- Description: Updates the views
- Usage: `views:update`

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 72% 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

Unknown

Total

1

Last Release

2973d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/33713d461682a7caa087fd0e9b6b4dc9065f96aa411863dace90fff68594683a?d=identicon)[marcharding](/maintainers/marcharding)

---

Top Contributors

[![marcharding](https://avatars.githubusercontent.com/u/3768?v=4)](https://github.com/marcharding "marcharding (85 commits)")[![tmloberon](https://avatars.githubusercontent.com/u/28302826?v=4)](https://github.com/tmloberon "tmloberon (32 commits)")[![adriankirchner](https://avatars.githubusercontent.com/u/149483?v=4)](https://github.com/adriankirchner "adriankirchner (1 commits)")

---

Tags

cliinstallerOXID

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[drush/drush

Drush is a command line shell and scripting interface for Drupal, a veritable Swiss Army knife designed to make life easier for those of us who spend some of our working hours hacking away at the command prompt.

2.4k57.4M685](/packages/drush-drush)[silverstripe/framework

The SilverStripe framework

7213.5M2.5k](/packages/silverstripe-framework)[n98/magerun

Tools for managing Magento projects and installations

1.4k264.7k7](/packages/n98-magerun)[humbug/php-scoper

Prefixes all PHP namespaces in a file or directory.

7963.0M35](/packages/humbug-php-scoper)[n98/magerun2

Tools for managing Magento projects and installations

928244.3k6](/packages/n98-magerun2)[laravel-zero/framework

The Laravel Zero Framework.

3371.4M369](/packages/laravel-zero-framework)

PHPackages © 2026

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