Prev |  | Next

## Using Virgo Shell Commands

### Note

This section is not applicable to Virgo Nano.

Virgo provides shell commands that allow you to examine artifacts currently installed in a particular Virgo Kernel instance, manage the lifecycle of the installed artifacts, install new artifacts, and shut down the Virgo Kernel. You can install, examine, and manage the lifecycle of the following artifacts:

- Bundles

- Configuration Artifacts

- PARs

- Plans

and can examine:

- Exported packages

- Services in the OSGi service registry

Virgo also provides shell commands to list all bundles that contain, export, or load a particular class.

These commands are provided for the user region shells only and are grouped together in the `vsh` scope.

You invoke commands using the `vsh:` scope. For example:

    osgi> vsh:plan list

    Name                                           Version                            State
    org.eclipse.virgo.apps.admin.plan              2.1.0                             ACTIVE
    org.eclipse.virgo.kernel.userregion.springdm   2.1.0                             ACTIVE
    org.eclipse.virgo.web                          2.1.0                             ACTIVE

    osgi>

### Virgo Shell Commands

The following table lists the Virgo shell commands; each command in turn has a variety of options that you can specify, depending on what you want to do, such as start a bundle or refresh a plan. The reference documentation about each command provides the full list of available options.

Table 8.1. Virgo Shell Commands

Command | Description
--- | ---
bundle | Manages and displays information about bundle artifacts.
clhas | Lists all bundles that contain a class or resource.
clexport | Lists all bundles that export a class or package.
clload | Lists all bundles that can load a class.
config | Manages and displays information about configuration artifacts.
packages | Displays information about exported packages.
par | Manages and displays information about PAR artifacts.
plan | Manages and displays information about plan artifacts.
service | Displays information about services in the OSGi service registry.
install | Installs an artifact to Virgo Kernel.
shutdown | Shuts down the Virgo Kernel instance to which the Equinox Console is connected.

Prev | Up | Next
| Home |