| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Apache Felix Gogo :: Apache Felix</title> |
| <link rel="canonical" href="https://felix.apache.org/documentation/subprojects/apache-felix-gogo.html"> |
| <meta name="generator" content="Antora 2.3.4"> |
| <link rel="stylesheet" href="../../_/css/site.css"> |
| <link rel="icon" href="../../_/img/favicon.png" type="image/x-icon"> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <a class="navbar-item" href="https://felix.apache.org/index.html"> |
| <span> |
| <img src="../../_/img/logo.png"> |
| </span> |
| </a> |
| <button class="navbar-burger" data-target="topbar-nav"> |
| <span></span> |
| <span></span> |
| <span></span> |
| </button> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <div class="navbar-end"> |
| <a class="navbar-item" href="https://felix.apache.org/index.html">Home</a> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Subprojects</a> |
| <div class="navbar-dropdown"> |
| <a class="navbar-item" href="apache-felix-dependency-manager.html">Dependency Manager</a> |
| <a class="navbar-item" href="apache-felix-event-admin.html">Event Admin</a> |
| <a class="navbar-item" href="apache-felix-file-install.html">File Install</a> |
| <a class="navbar-item" href="apache-felix-framework.html">Framework</a> |
| <a class="navbar-item" href="apache-felix-gogo.html">Gogo Shell</a> |
| <a class="navbar-item" href="apache-felix-healthchecks.html">Health Checks</a> |
| <a class="navbar-item" href="apache-felix-inventory.html">Inventory</a> |
| <a class="navbar-item" href="apache-felix-log.html">Log</a> |
| <a class="navbar-item" href="apache-felix-logback.html">Logback</a> |
| <a class="navbar-item" href="apache-felix-maven-bundle-plugin.html">Maven bundle plugin</a> |
| <a class="navbar-item" href="apache-felix-maven-scr-plugin.html">Maven SCR plugin</a> |
| <a class="navbar-item" href="apache-felix-metatype-service.html">Metatype Service</a> |
| <a class="navbar-item" href="apache-felix-preferences-service.html">Preferences Service</a> |
| <a class="navbar-item" href="apache-felix-remote-shell.html">Remote Shell</a> |
| <a class="navbar-item" href="apache-felix-script-console-plugin.html">Script console plugin</a> |
| <a class="navbar-item" href="apache-felix-shell.html">Lightweight shell</a> |
| <a class="navbar-item" href="apache-felix-shell-tui.html">Shell TUI</a> |
| <a class="navbar-item" href="apache-felix-web-console.html">Web Console</a> |
| </div> |
| </div> |
| <div class="navbar-item"> |
| <span class="control"> |
| <a class="button is-primary" href="../downloads.html">Downloads</a> |
| </span> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <div class="body"> |
| <div class="nav-container" data-component="documentation" data-version="master"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <h3 class="title"><a href="../index.html">Documentation</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../documentation.html">Documentation</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../downloads.html">Downloads</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../getting-started.html">Getting Started</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../news.html">News</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Community</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../community/project-info.html">Apache Felix Project Info</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../community/contributing.html">Contributing</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../community/projects-using-felix.html">Projects Using Felix</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Development</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../development/coding-standards.html">Coding Standards</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../development/dependencies-file-template.html">DEPENDENCIES file template</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../development/provisional-osgi-api-policy.html">Provisional OSGi API Policy</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../development/release-management-nexus.html">Release Management</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../development/site-how-to.html">Site How To</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../development/using-the-osgi-compliance-tests.html">Using the OSGi Compliance Tests</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../faqs.html">FAQS</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../faqs/apache-felix-bundle-plugin-faq.html">Apache Felix Bundle Plugin Frequently Asked Questions</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../faqs/apache-felix-scr-plugin-faq.html">Apache Felix SCR Plugin Frequently Asked Questions</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../subprojects.html">Subprojects</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="apache-felix-dependency-manager.html">Apache Felix Dependency Manager</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Guides</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/migrating-from-earlier-versions.html">Apache Felix Dependency Manager - Migrating from earlier versions</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/annotations.html">Dependency Manager - Annotations</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/background.html">Dependency Manager - Background</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/bundles-and-dependencies.html">Dependency Manager - Bundles and Dependencies</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/design-patterns.html">Dependency Manager - Design Patterns</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/development.html">Dependency Manager - Development</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/history.html">Dependency Manager - History</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/javadocs.html">Dependency Manager - JavaDocs</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/migrating-from-other-solutions.html">Dependency Manager - Migrating from other solutions.</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/performance-tuning.html">Dependency Manager - Performance Tuning</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/resources.html">Dependency Manager - Resource adapters</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/whatsnew.html">Dependency Manager - What’s new in version 4?</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/dm-lambda.html">Dependency Manager Lambda</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/guides/whatsnew-r15.html">What’s New in R15</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Reference</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/component-adapter.html">Dependency Manager - Adapter</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/component-aspect.html">Dependency Manager - Aspect</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/component-bundle-adapter.html">Dependency Manager - Bundle Adapter</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-bundle.html">Dependency Manager - Bundle Dependency</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/components.html">Dependency Manager - Components</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-configuration.html">Dependency Manager - Configuration Dependency</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/dependencies.html">Dependency Manager - Dependencies</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/external-links.html">Dependency Manager - External Links</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/component-factory-configuration-adapter.html">Dependency Manager - Factory Configuration Adapter Service</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/component-resource-adapter.html">Dependency Manager - Resource Adapter</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-resource.html">Dependency Manager - Resource Dependency</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-service.html">Dependency Manager - Service Dependency</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/service-scopes.html">Dependency Manager - Service Scopes</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/component-singleton.html">Dependency Manager - Singleton Component</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/thread-model.html">Dependency Manager - Thread Model</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/reference/dm-annotations.html">Dependency Manager Annotations</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Tutorials</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/tutorials/working-with-annotations.html">Dependency Manager - Annotations</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/tutorials/getting-started.html">Dependency Manager - Getting Started</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/tutorials/leveraging-the-shell.html">Dependency Manager - Leveraging the shell</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-dependency-manager/tutorials/sample-code.html">Dependency Manager sample projects</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-event-admin.html">Apache Felix Event Admin</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-file-install.html">Apache Felix File Install</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="apache-felix-framework.html">Apache Felix Framework</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-framework/apache-felix-framework-bundle-cache.html">Apache Felix Framework Bundle Cache</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-framework/apache-felix-framework-configuration-properties.html">Apache Felix Framework Configuration Properties</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-framework/apache-felix-framework-faq.html">Apache Felix Framework Frequently Asked Questions</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-framework/apache-felix-framework-launching-and-embedding.html">Apache Felix Framework Launching and Embedding</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-framework/apache-felix-framework-usage-documentation.html">Apache Felix Framework Usage Documentation</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-framework-security.html">Apache Felix Framework Security</a> |
| </li> |
| <li class="nav-item is-current-page" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="apache-felix-gogo.html">Apache Felix Gogo</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-gogo/rfc-147-overview.html">RFC 147 Overview</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-healthchecks.html">Apache Felix Health Checks</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-inventory.html">Apache Felix Inventory Printer</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-log.html">Apache Felix Log</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-logback.html">Apache Felix Logback</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-maven-bundle-plugin-bnd.html">Apache Felix Maven Bundle Plugin (BND)</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-metatype-service.html">Apache Felix Metatype Service</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-osgi-bundle-repository.html">Apache Felix OSGi Bundle Repository (OBR)</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-preferences-service.html">Apache Felix Preferences Service</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-remote-shell.html">Apache Felix Remote Shell</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-shell.html">Apache Felix Shell</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="apache-felix-shell-tui.html">Apache Felix Shell TUI</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="apache-felix-web-console.html">Apache Felix Web Console</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console.html">Extending the Apache Felix Web Console</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-web-console/web-console-restful-api.html">Web Console RESTful API</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="apache-felix-web-console/web-console-security-provider.html">Web Console Security Provider</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Extensions</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/branding-the-web-console.html">Branding the Web Console</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.html">Providing Resources</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/providing-web-console-plugins.html">Providing Web Console Plugins</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/web-console-logging.html">Web Console Logging</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/web-console-output-templating.html">Web Console Output Templating</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../tutorials-examples-and-presentations.html">Tutorials</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-application-demonstration.html">Apache Felix Application Demonstration</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial.html">Apache Felix OSGi Tutorial</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-faq.html">OSGi Frequently Asked Questions</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">OSGI Tutorial</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-1.html">Apache Felix Tutorial Example 1 - Service Event Listener Bundle</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-2.html">Apache Felix Tutorial Example 2</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-2b.html">Apache Felix Tutorial Example 2b</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-3.html">Apache Felix Tutorial Example 3</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-4.html">Apache Felix Tutorial Example 4</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-5.html">Apache Felix Tutorial Example 5</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-6.html">Example 6 - Spell Checker Service Bundle</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-7.html">Example 7 - Spell Checker Client Bundle</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-8.html">Example 8 - Spell Checker Service using Service Binder</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-9.html">Example 9 - Spell Checker Service using Declarative Services</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../license.html">Apache License 2.0</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../site-map.html">Site map</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| <div class="nav-panel-explore" data-panel="explore"> |
| <div class="context"> |
| <span class="title">Documentation</span> |
| <span class="version">master</span> |
| </div> |
| <ul class="components"> |
| <li class="component is-current"> |
| <span class="title">Documentation</span> |
| <ul class="versions"> |
| <li class="version is-current is-latest"> |
| <a href="../index.html">master</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main class="article"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="../index.html" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="../index.html">Documentation</a></li> |
| <li><a href="../subprojects.html">Subprojects</a></li> |
| <li><a href="apache-felix-gogo.html">Apache Felix Gogo</a></li> |
| </ul> |
| </nav> |
| <div class="edit-this-page"><a href="https://github.com/apache/felix-antora-site/edit/main/modules/ROOT/pages/subprojects/apache-felix-gogo.adoc">Edit this Page</a></div> |
| </div> |
| <div class="content"> |
| <article class="doc"> |
| <h1 class="page">Apache Felix Gogo</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Apache Felix Gogo is a subproject of Apache Felix implementing a command line shell for OSGi. |
| It is used in many OSGi runtimes and servers (Felix distro, Eclipse IDE, Apache Karaf, …​).</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_overview"><a class="anchor" href="#_overview"></a>Overview</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The Gogo subproject consists of three bundles:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><em>runtime</em> - implements the core command processing functionality.</p> |
| </li> |
| <li> |
| <p><em>command</em> - implements a set of basic commands.</p> |
| </li> |
| <li> |
| <p><em>jline</em> - Advanced textual user interface with features like completion and colors</p> |
| </li> |
| <li> |
| <p><em>shell</em> - provides a simple textual user interface to interact with the command processor.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_working_with_the_sources"><a class="anchor" href="#_working_with_the_sources"></a>Working with the sources</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>You can find the <a href="https://svn.apache.org/repos/asf/felix/trunk/gogo/">sources on apache svn</a> there is also <a href="https://github.com/apache/felix/tree/trunk/gogo">a mirror at github</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Clone git clone <a href="https://github.com/apache/felix" class="bare">https://github.com/apache/felix</a></p> |
| </div> |
| <div class="paragraph"> |
| <p>Build cd gogo mvn clean install</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_using_gogo_with_the_felix_framework"><a class="anchor" href="#_using_gogo_with_the_felix_framework"></a>Using Gogo with the Felix Framework</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Gogo is included as the default shell in the felix framework distribution. |
| To use it, you just start the framework like normal:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-console hljs" data-lang="console">$ java -jar bin/felix.jar |
| _______________ |
| Welcome to Apache Felix Gogo |
| |
| g!</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Gogo shell integration in the framework distribution is also discussed in the <a href="apache-felix-framework/apache-felix-framework-usage-documentation.html" class="page">framework usage document</a></p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_built_in_shell_features"><a class="anchor" href="#_built_in_shell_features"></a>Built in shell features</h2> |
| <div class="sectionbody"> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>TAB</p> |
| <div class="paragraph"> |
| <p>Completion for commands and parameters</p> |
| </div> |
| </li> |
| <li> |
| <p>Cursor left, Cursor right</p> |
| <div class="paragraph"> |
| <p>Edit inside current line</p> |
| </div> |
| </li> |
| <li> |
| <p>Cursor up, Cursor down</p> |
| <div class="paragraph"> |
| <p>Scroll through history</p> |
| </div> |
| </li> |
| <li> |
| <p>Ctrl-C</p> |
| <div class="paragraph"> |
| <p>Interrupt execution of current command</p> |
| </div> |
| </li> |
| <li> |
| <p>Ctrl-D</p> |
| <div class="paragraph"> |
| <p>Exit the shell</p> |
| </div> |
| </li> |
| <li> |
| <p>Ctrl-R</p> |
| <div class="paragraph"> |
| <p>Search in history</p> |
| </div> |
| </li> |
| <li> |
| <p></p> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><em>[command1]</em></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><em>[command2]</em></p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>Pipe output of command1 as input of command2</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_basic_commands"><a class="anchor" href="#_basic_commands"></a>Basic commands</h2> |
| <div class="sectionbody"> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>cat <em>[URI]</em></p> |
| <div class="paragraph"> |
| <p>Read URI and print to stdout</p> |
| </div> |
| </li> |
| <li> |
| <p>cd <em>[path]</em></p> |
| <div class="paragraph"> |
| <p>Change working directory</p> |
| </div> |
| </li> |
| <li> |
| <p>diag <em>[bundleid]</em></p> |
| <div class="paragraph"> |
| <p>Shows why a bundle is not working</p> |
| </div> |
| </li> |
| <li> |
| <p>help</p> |
| <div class="paragraph"> |
| <p>Show the available commands</p> |
| </div> |
| </li> |
| <li> |
| <p>help <em>[command]</em></p> |
| <div class="paragraph"> |
| <p>Shows detailed help about a command</p> |
| </div> |
| </li> |
| <li> |
| <p>head <em>[bundleid]</em></p> |
| <div class="paragraph"> |
| <p>Print bundle headers</p> |
| </div> |
| </li> |
| <li> |
| <p>history</p> |
| <div class="paragraph"> |
| <p>Shows the history of executed commands</p> |
| </div> |
| </li> |
| <li> |
| <p>inspect capability service <em>[bundleid]</em></p> |
| <div class="paragraph"> |
| <p>Lists all services provided by a bundle</p> |
| </div> |
| </li> |
| <li> |
| <p>inspect requirement service <em>[bundleid]</em></p> |
| <div class="paragraph"> |
| <p>Lists all services required by a bundle</p> |
| </div> |
| </li> |
| <li> |
| <p>install <em>[URI]</em></p> |
| <div class="paragraph"> |
| <p>Install a bundle from file or URI</p> |
| </div> |
| </li> |
| <li> |
| <p>lb</p> |
| <div class="paragraph"> |
| <p>List bundles</p> |
| </div> |
| </li> |
| <li> |
| <p></p> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><em>[command1]</em></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">less</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>Show output of command1 in a paged view</p> |
| </div> |
| </li> |
| <li> |
| <p>less <em>[file]</em></p> |
| <div class="paragraph"> |
| <p>Show file in a paged view</p> |
| </div> |
| </li> |
| <li> |
| <p>ls <em>[directory]</em></p> |
| <div class="paragraph"> |
| <p>Show directory contents</p> |
| </div> |
| </li> |
| <li> |
| <p>start <em>[bundleid]</em></p> |
| <div class="paragraph"> |
| <p>Start the given bundle</p> |
| </div> |
| </li> |
| <li> |
| <p>stop <em>[bundleid]</em></p> |
| <div class="paragraph"> |
| <p>Stop the given bundle</p> |
| </div> |
| </li> |
| <li> |
| <p>tac</p> |
| <div class="paragraph"> |
| <p>Capture stdin as string and optionally write to file</p> |
| </div> |
| </li> |
| <li> |
| <p>tail <em>[file]</em></p> |
| <div class="paragraph"> |
| <p>Shows the last lines of a file. |
| Using -f allows to follow the file changes.</p> |
| </div> |
| </li> |
| <li> |
| <p>uninstall <em>[bundleid]</em></p> |
| <div class="paragraph"> |
| <p>Uninstall given bundle</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_changing_shell_colors"><a class="anchor" href="#_changing_shell_colors"></a>Changing shell colors</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The colors of the command shell cane be adjusted by setting a property in an init script or directly on the shell.</p> |
| </div> |
| <div class="paragraph"> |
| <p>HIGHLIGHTER_COLORS = "rs=35:st=32:nu=32:co=32:va=36:vn=36:fu=94:bf=91:re=90"</p> |
| </div> |
| <div class="paragraph"> |
| <p>The property above forms a map from highlight type to ANSI color code.</p> |
| </div> |
| <div class="paragraph"> |
| <p>These are the highlight types</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>rs : Reserved words</p> |
| </li> |
| <li> |
| <p>st : Strings</p> |
| </li> |
| <li> |
| <p>nu : Numbers</p> |
| </li> |
| <li> |
| <p>co : Constants</p> |
| </li> |
| <li> |
| <p>va : Variable</p> |
| </li> |
| <li> |
| <p>vn : Variable name</p> |
| </li> |
| <li> |
| <p>fu : Function</p> |
| </li> |
| <li> |
| <p>bf : Bad function</p> |
| </li> |
| <li> |
| <p>un : Unknown</p> |
| </li> |
| <li> |
| <p>re : Repair</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>The colors of the ls output can be adjusted using</p> |
| </div> |
| <div class="paragraph"> |
| <p>LS_COLORS = "dr=1;91:ex=1;92:sl=1;96:ot=34;43"</p> |
| </div> |
| <div class="paragraph"> |
| <p>The color types are these:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>dr : Directory</p> |
| </li> |
| <li> |
| <p>ex : Executable</p> |
| </li> |
| <li> |
| <p>sl : Symbolic Link</p> |
| </li> |
| <li> |
| <p>ot : Other</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Last but not least grep can also be adjusted</p> |
| </div> |
| <div class="paragraph"> |
| <p>GREP_COLORS = "mt=1;31:fn=35:ln=32:se=36"</p> |
| </div> |
| <div class="paragraph"> |
| <p>Types:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>mt : Hits in the text (sets both ms and mc)</p> |
| </li> |
| <li> |
| <p>ms : Matching text in selected line</p> |
| </li> |
| <li> |
| <p>mc : Matching text in context line</p> |
| </li> |
| <li> |
| <p>fn : File names</p> |
| </li> |
| <li> |
| <p>ln : Line numbers</p> |
| </li> |
| <li> |
| <p>se : Selected lines</p> |
| </li> |
| <li> |
| <p>sl : Whole selected line</p> |
| </li> |
| <li> |
| <p>cx : Context lines</p> |
| </li> |
| <li> |
| <p>rv : If set and match is inverted, the meaning of sl and cx is inverted</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_origin_in_rfc_147"><a class="anchor" href="#_origin_in_rfc_147"></a>Origin in RFC 147</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Gogo is based on the OSGi RFC 147, which describes a standard shell for OSGi-based environments. |
| See <a href="apache-felix-gogo/rfc-147-overview.html" class="page">RFC 147 Overview</a> for more information. |
| Unfortunately this RFC was never made a standard.</p> |
| </div> |
| </div> |
| </div> |
| </article> |
| <aside class="toc sidebar" data-title="Contents" data-levels="2"> |
| <div class="toc-menu"></div> |
| </aside> |
| </div> |
| </main> |
| </div> |
| <footer class="footer"> |
| <p>Content licensed under AL2. UI licensed under MPL-2.0 with extensions licensed under AL2</p> |
| </footer> |
| <script src="../../_/js/site.js"></script> |
| <script async src="../../_/js/vendor/highlight.js"></script> |
| </body> |
| </html> |
