PHPackages                             oxid-professional-services/oxid-console - 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. oxid-professional-services/oxid-console

AbandonedArchivedLibrary

oxid-professional-services/oxid-console
=======================================

the oxid professional services console for oxid

6.0.1(5y ago)772.0k↓36.1%5[5 issues](https://github.com/OXIDprojects/oxid-console/issues)[2 PRs](https://github.com/OXIDprojects/oxid-console/pulls)1GPL-3.0-onlyPHPPHP ^7.1

Since Dec 14Pushed 5y ago15 watchersCompare

[ Source](https://github.com/OXIDprojects/oxid-console)[ Packagist](https://packagist.org/packages/oxid-professional-services/oxid-console)[ RSS](/packages/oxid-professional-services-oxid-console/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (55)Used By (1)

OXID PS Console
===============

[](#oxid-ps-console)

OXID PS Console is a Symfony console application for OXID eShop. It is community and project driven with write and read access like in a public wiki (like Wikipedia).

The following commands are available:

- `cache:clear` - Clear OXID cache
- `views:update` - Regenerate database views
- `module:activate` - Activate module in shop
- `module:generate` - Generate new module scaffold
- `module:fix` - Fix the module chain based on the metadata contents
- `migration:generate` - Generate new migration file
- `migration:run` - Run migration scripts

For backwards compatibility the following commands are still available (*but are deprecated*):

- `db:update` - Updates database views
- `g:migration` - Generate new migration file
- `g:module` - Generate new module scaffold
- `list` - *(default)* List of all available commands
- `migrate` - Run migration scripts

Which version to get?
---------------------

[](#which-version-to-get)

OXID VersionOXID Console versionSource Code linkDownload link<4.9.0, <5.2.01.1.5[Source Code](https://github.com/OXIDprojects/oxid-console/tree/3e28bba67649c01156c6e97f1b99aa7538b1a32e)[Download ZIP](https://github.com/OXIDprojects/oxid-console/archive/v1.1.5.zip)>=4.9.0, >=5.2.01.2.6[Source Code](https://github.com/OXIDprojects/oxid-console/tree/f7dedca4d831bf5cb52e1b17024f2b70cf789b2c)[Download ZIP](https://github.com/OXIDprojects/oxid-console/archive/v1.2.6.zip)=6.1.x6.0[Source Code](https://github.com/OXIDprojects/oxid-console/)please use composer to install see next section=6.2.x-use with care oxid console is not designed to be used with oxid 6.2 for nowInstallation
------------

[](#installation)

Use Composer to add the console to your project

```
composer require oxid-professional-services/oxid-console
```

Getting started
---------------

[](#getting-started)

```
vendor/bin/oxid list
```

Defining your own command
-------------------------

[](#defining-your-own-command)

- Class must extend `Symfony\Component\Console\Command\Command` class
- Add the following in the services.yaml json of your module (composer package)

```
  services:
    oxid_community.moduleinternals.module.fix.command:
      class: OxidCommunity\ModuleInternals\Command\ModuleFixCommand
      tags:
      - { name: 'console.command' }
```

### Template for your command:

[](#template-for-your-command)

```