Liferay Gogo Shell Commands

Overview

Gogo Shell is a command-line tool for executing Felix Gogo Shell commands and Liferay commands. This article describes the main Gogo Shell commands.

List Bundles

Command: lb <filter>

Description: list installed bundles matching a substring

Sample:

g! lb apps

START LEVEL 20

   ID|State      |Level|Name

 1427|Active     |   10|Liferay Apps Manager API (1.0.0)|1.0.0

 1428|Active     |   10|Liferay Apps Manager Service (1.0.0)|1.0.0

 1429|Active     |   10|Liferay Apps Web (1.0.0)|1.0.0

Bundle Diagnostics

Command: diag <bundle-id>

Description: Displays unsatisfied constraints for the specified bundle

Sample:

g! diag com.liferay.apps.web

com.liferay.apps.web [1429]

  No resolution report for the bundle.

Bundle Details

Command: b <bundle-id>

Description: Displays bundle details

Sample:

g! b com.liferay.apps.web

com.liferay.apps.web_1.0.0 [1429]

  Id=1429, Status=ACTIVE      Data Root=/home/vitaliy/Work/Projects/liferay/liferay-demo/liferay-apps/bundles/osgi/state/org.eclipse.osgi/1429/data

  "Registered Services"

    {com.liferay.apps.web.internal.security.permission.resource.AppModelPermission}={service.id=16848, service.bundleid=1429, service.scope=bundle, EntryModelPermission.target=(model.class.name=com.liferay.apps.manager.model.App), component.name=com.liferay.apps.web.internal.security.permission.resource.AppModelPermission, component.id=9195}

    {javax.portlet.Portlet}={com.liferay.portlet.css-class-wrapper=app-manager, service.id=16849, service.bundleid=1429, service.scope=bundle, javax.portlet.init-param.template-path=/, com.liferay.portlet.display-category=category.liferay, javax.portlet.display-name=App Manager, component.name=com.liferay.apps.web.portlet.AppManagerPortlet, component.id=9197, javax.portlet.init-param.view-template=/view.jsp, com.liferay.portlet.instanceable=false, javax.portlet.security-role-ref=power-user,user, javax.portlet.name=com_liferay_apps_web_portlet_AppManagerPortlet, javax.portlet.resource-bundle=content.Language}

    {org.osgi.service.http.context.ServletContextHelper}={service.id=16850, osgi.http.whiteboard.context.name=com.liferay.apps.web, service.bundleid=1429, service.scope=singleton, rtl.required=true, osgi.http.whiteboard.context.path=/com.liferay.apps.web}

...

Start Bundle

Command: start <bundle-id>

Description: Starts the bundle

Samples:

g! start com.liferay.apps.web // Start by symbolic name

g! start 1429   // Start by Bundle ID

Stop Bundle

Command: stop <bundle-id>

Description: Stops the bundle

Samples:

g! stop com.liferay.apps.web // Stop by symbolic name

g! stop 1429   // Stop by Bundle ID

List Bundle Components

Command: scr:list <bundle-name>

Description: Lists components of bundle

Sample:

g! scr:list 1429

com.liferay.apps.web.internal.security.permission.resource.AppsPermission in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9196, State:ACTIVE

com.liferay.apps.web.portlet.action.ViewMVCRenderCommand in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9201, State:ACTIVE

com.liferay.apps.web.internal.asset.model.AppAssetRendererFactory in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9194, State:ACTIVE

com.liferay.apps.web.portlet.action.EditAppMVCActionCommand in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9199, State:ACTIVE

com.liferay.apps.web.portlet.action.DeleteAppMVCActionCommand in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9198, State:ACTIVE

com.liferay.apps.web.portlet.AppManagerPortlet in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9197, State:ACTIVE

com.liferay.apps.web.internal.security.permission.resource.AppModelPermission in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9195, State:ACTIVE

com.liferay.apps.web.portlet.action.EditAppMVCRenderCommand in bundle 1,429 (com.liferay.apps.web:1.0.0) enabled, 1 instance.

    Id: 9200, State:ACTIVE

Component Information

Command: scr:info <component-name>

Description: Dump information of a component

Sample:

g! scr:info com.liferay.apps.web.portlet.action.ViewMVCRenderCommand

Component Description: com.liferay.apps.web.portlet.action.ViewMVCRenderCommand

===============================================================================

Class:         com.liferay.apps.web.portlet.action.ViewMVCRenderCommand

Bundle:        1429 (com.liferay.apps.web:1.0.0)

Enabled:       true

Immediate:     true

Services:      [com.liferay.portal.kernel.portlet.bridges.mvc.MVCRenderCommand]

Scope:         singleton

Config PID(s): [com.liferay.apps.web.portlet.action.ViewMVCRenderCommand], Policy: optional

Base Props:    (2 entries)

  javax.portlet.name<String> = com_liferay_apps_web_portlet_AppManagerPortlet

  mvc.command.name<String[]> = [/, /apps/view]

Component Configuration Id: 9185

--------------------------------

State:        ACTIVE

Service:      16813 [com.liferay.portal.kernel.portlet.bridges.mvc.MVCRenderCommand]

    Used by bundle 0 (org.eclipse.osgi:3.13.0.LIFERAY-PATCHED-11)

Config Props: (4 entries)

  component.id<Long> = 9185

  component.name<String> = com.liferay.apps.web.portlet.action.ViewMVCRenderCommand

  javax.portlet.name<String> = com_liferay_apps_web_portlet_AppManagerPortlet

  mvc.command.name<String[]> = [/, /apps/view]

References:   (total 0)

g! 

Check Unsatisfied Dependencies 

Command: ds:unsatisfied

Description: Checks for unsatisfied dependencies

Sample:

g! ds:unsatisfied

Enjoy 😏