PHPackages                             asika/jconsole - 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. asika/jconsole

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

asika/jconsole
==============

Useful Cli tools for Joomla CMS

1.0.9(10y ago)2951[14 issues](https://github.com/asika32764/JConsole/issues)PHP

Since Feb 17Pushed 10y ago1 watchersCompare

[ Source](https://github.com/asika32764/JConsole)[ Packagist](https://packagist.org/packages/asika/jconsole)[ RSS](/packages/asika-jconsole/feed)WikiDiscussions staging Synced 3d ago

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

JConsole
========

[](#jconsole)

#### An useful console tools for Joomla CMS

[](#an-useful-console-tools-for-joomla-cms)

JConsole is a cli tools implement from [Joomla Console Package](https://github.com/asika32764/joomla-framework/tree/console/src/Joomla/Console). It provides an interface to create nested commands.

About Console package:

Please see:

> Note: Console package has not added to Joomla Framework yet, it is an experimental package.

Installation via Composer
-------------------------

[](#installation-via-composer)

```
cd your/joomla/path

php composer.phar create-project asika/jconsole libraries/jconsole 1.0.*
```

Then, remove `libraries/jconsole/.gitignore` if you want to track whole Joomla by Git, use root gitignore instead.

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

[](#getting-started)

Open terminal, go to `path/of/joomla`.

Type:

```
php cli/console
```

Will get a help message:

```
Joomla! Console - version: 1.0
------------------------------------------------------------

[console Help]

Usage:
  console  [option]

Options:

  -h | --help       Display this help message.
  -q | --quiet      Do not output any message.
  -v | --verbose    Increase the verbosity of messages.
  --no-ansi         Suppress ANSI colors on unsupported terminals.

Available commands:

  help      List all arguments and show usage & manual.

  build     Some useful tools for building system.

  sql       Example description.

  system    System control.

Welcome to Joomla! Console.

```

Available Commands
------------------

[](#available-commands)

```
  help                   List all arguments and show usage & manual.

  build                  Some useful tools for building system.
      check-constants    Check php files which do not included Joomla constants.
      gen-command        Generate a command class.
      index              Create empty index.html files in directories.

  sql                    SQL migration tools.
      backup             Backup sql.
      col                Column operation
      export             Export sql.
      import             Import a sql file.
      profile            Profiles.
      restore            Restore to pervious point.
      table              Model operation.

  system                 System control.
      clean-cache        Clean system cache.
      off                Set this site offline.
      on                 Set this site online.

```

Add your own Commands
---------------------

[](#add-your-own-commands)

### Use Plugin

[](#use-plugin)

Create a plugin in `console` group.

```