Skip to main content

Helpful Helios FHIR Server Karaf Commands

Command

Description

Example Usage

bundle:list

List the bundles installed in the Helios FHIR Server. To see system level bundles, add -t 0

bundle:list

bundle:list -t 0

bundle:start [bundleId]

Start an installed bundle. (The bundleId is the number returned by bundle:install)

bundle:start 123

bundle:stop [bundleId]

Stop an active bundle

bundle:stop 123

bundle:install [-s] [mvnUrl]

Install a bundle by Maven URL. -s can be added to also start the bundle (saves a step in dev)

bundle:install mvn:com.heliossoftware.hfs/fhir-core/0.0.1-SNAPSHOT

bundle:install -s mvn:com.heliossoftware.hfs/resources-api/0.0.1-SNAPSHOT

bundle:uninstall [bundleId]

Uninstall a bundle by bundle ID. This is rare, but can be done when removing functionality.

bundle:uninstall 123

bundle:watch [bundleId]

Watch and automatically a bundle. This is extremely useful in development. Change code, rebuild your bundle, Karaf automatically updates the bundle. Can use * in place of bundleId to watch all bundles

bundle:watch 123

bundle:watch *

bundle:headers [bundleId]

List all packages and services used and exposed by the bundle. Useful in debugging missing dependencies

bundle:headers 123

bundle:diag [bundleId]

Diagnose issues with a bundle. Similar to bundle:headers but typically more relevant information

bundle:diag 123

log:tail

Tail the Helios FHIR Server logs

log:tail

exports

List all packages available in the system. Useful in debugging why a bundle cannot find a package

exports

feature:list

List all features available to the system. A feature is a grouping of bundles

feature:list

shutdown

Shutdown the Karaf container

shutdown

logout

Logout of your session (./client) or shutdown the Karaf container (./karaf)

logout

services [bundleId]

List the services that bundleId provides

services 123