README.md
September 21, 2026 · View on GitHub
An easy-to-use desktop application to manage OSGi frameworks remotely
❓ Why OSGi.fx?
OSGi.fx is the ultimate remote management tool for your OSGi frameworks. Unlike legacy consoles, it offers a modern, responsive JavaFX interface that gives you:
- 🚀 Deep Insights: Visualize bundles, services, users, components, and conditions instantly.
- ⚡ Real-time Monitoring: Track threads, heap usage, and logs live.
- �️ Visual Dependencies: Explore complex relationships with interactive graphs.
- ✨ Ease of Use: Drag-and-drop installs, smart auto-complete, and valid configuration editing.
- 🤖 AI Ready: Built-in Model Context Protocol (MCP) server for seamless AI agent integration.
- 🧠 AI Command Builder: Generate Gogo shell commands from natural language — instant Smart Match or optional remote LLM integration.
�📸 Gallery
🛠️ Tech Stack
| Component | Technology |
|---|---|
| ☕ Java (Application) | 25 |
| ☕ Java (Agent) | 1.8 |
| 🖥️ Rich Client Platform | JavaFX 25 |
| ⚙️ Runtime (Application) | OSGi R8 (Equinox), Eclipse 4 (e4), e(fx)clipse |
| ⚙️ Runtime (Agent) | OSGi R6 |
| 🎨 UI Libraries | ControlsFX, TilesFX, FormsFX |
| 🛠️ Software Tools | Bndtools 7.2.1 |
🚀 Getting Started
The latest released version is 3.1.0.
📥 Download & Install
Visit the Project Website to download and install the latest version for your platform.
For detailed instructions, please refer to the User Guide on the website or check our local User Guide.
🔌 IDE Integration
Experience OSGi.fx directly within your development environment with the OSGi.fx Eclipse Plugin.
- ⚡ Seamless Launch: Start the OSGi.fx console directly from Eclipse.
- 🛠️ Connection Profiles: Manage your Socket and MQTT connections within the IDE.
- ⚙️ Auto-Managed Runtime: Automatic setup of the required JavaFX 25 environment.
- 🎨 Visual Status: Real-time tracking of connection status with intuitive icons.
- 📦 Update Sites: Install via
Help > Install New Software...using:- 🚀 Latest Release:
https://osgifx.com/eclipse - 🧪 Staging / Beta:
https://osgifx.com/eclipse-staging
- 🚀 Latest Release:
🔐 Authentication & Security
Starting from 3.0.0, OSGi.fx supports secure connections with password authentication and TLS/SSL encryption for both Socket and MQTT protocols.
Key Features:
- 🔒 Password-protected connections with AES-256 encrypted credential storage
- 🔐 TLS/SSL support for Socket connections
- 🎫 OAuth/Token authentication for MQTT brokers
- 💾 Optional "Save Password" with secure prompting when needed
- ✨ Smart UI bindings between authentication fields
For detailed setup instructions, see the User Guide.
✨ Features
| Feature | Version | Implemented | Released |
|---|---|---|---|
| 📦 Bundle Inventory View all installed bundles and fragments | 2.4.4 | ✅ | 🚀 |
| 📦 Package Insights Explore exported and imported packages | 2.4.4 | ✅ | 🚀 |
| 🛠️ Service Registry Inspect all registered OSGi services | 2.4.4 | ✅ | 🚀 |
| 🧩 Component Viewer Visualize declarative services (DS) components | 2.4.4 | ✅ | 🚀 |
| ⚙️ System Properties Access robust system and framework properties | 2.4.4 | ✅ | 🚀 |
| 🧵 Thread Monitor Track daemon and non-daemon threads | 2.4.4 | ✅ | 🚀 |
| 📢 Event Emitter Dispatch synchronous or asynchronous events | 2.4.4 | ✅ | 🚀 |
| 👂 Event Listener Subscribe to OSGi events in real-time | 2.4.4 | ✅ | 🚀 |
| 📝 Log Stream Live streaming of OSGi logs | 2.4.4 | ✅ | 🚀 |
| logger R7 Logger Config Manage OSGi R7 logger levels and configurations | 2.4.4 | ✅ | 🚀 |
| 🐚 Gogo Shell Execute Gogo commands remotely | 2.4.4 | ✅ | 🚀 |
| 💻 CLI Executor Run system CLI commands directly | 2.4.4 | ✅ | 🚀 |
| ✨ Smart Auto-Complete Intelligent suggestion for remote Gogo commands | 2.4.4 | ✅ | 🚀 |
| 📥 Bundle Manager Install, update, starting and stopping bundles | 2.4.4 | ✅ | 🚀 |
| 🖱️ Drag & Drop Install Effortless bundle installation via drag-and-drop | 2.4.4 | ✅ | 🚀 |
| 🔧 Config Admin Manage configurations via ConfigurationAdmin | 2.4.4 | ✅ | 🚀 |
| 📋 Metatype Inspector Browse OCDs and property descriptors | 2.4.4 | ✅ | 🚀 |
| ⏯️ Bundle Lifecycle Start, stop, and uninstall bundles/fragments | 2.4.4 | ✅ | 🚀 |
| ⚡ Component Control Enable or disable DS components on the fly | 2.4.4 | ✅ | 🚀 |
| ✏️ Config Editor Create, update, and delete configurations | 2.4.4 | ✅ | 🚀 |
| 🏗️ Config Factory Instantiate new configurations from factory PIDs | 2.4.4 | ✅ | 🚀 |
| 📊 Runtime Dashboard Overview of memory, uptime, bundles, threads, and services | 2.4.4 | ✅ | 🚀 |
| 🕸️ Bundle Graph Visualize bundle dependencies interactively | 2.4.4 | ✅ | 🚀 |
| 🔗 Component Graph Visualize DS component references and dependencies | 2.4.4 | ✅ | 🚀 |
| 🔄 Cycle Detector Identify circular dependencies in DS components | 2.4.4 | ✅ | 🚀 |
| 📤 Graph Export Export dependency graphs to DOT (GraphViz) format | 2.4.4 | ✅ | 🚀 |
| 📂 Log Viewer Access and analyze application log files | 2.4.4 | ✅ | 🚀 |
| 🕵️ Leak Detector Identify suspicious classloader leaks | 2.4.4 | ✅ | 🚀 |
| 🌐 HTTP Runtime Inspect Servlets, Filters, and Resources | 2.4.4 | ✅ | 🚀 |
| 📈 Heap Monitor Real-time heap usage and GC tracking | 2.4.4 | ✅ | 🚀 |
| 🔌 Extension Manager Install and manage external plugins | 2.4.4 | ✅ | 🚀 |
| 🗑️ Extension Uninstaller Remove installed extensions easily | 2.4.4 | ✅ | 🚀 |
| 📜 OBR Generator Generate OBR XML repositories | 2.4.4 | ✅ | 🚀 |
| 🌲 DMT Explorer Traverse and update the Device Management Tree | 2.4.4 | ✅ | 🚀 |
| 👥 User Admin Manage roles, users, and groups | 2.4.4 | ✅ | 🚀 |
| ❤️ Health Checks Execute and monitor Felix Health Checks | 2.4.4 | ✅ | 🚀 |
| 📸 Snapshot Capture and analyze runtime state snapshots | 2.4.4 | ✅ | 🚀 |
| ℹ️ DTO Inspector Explore standard OSGi Runtime DTOs | 2.4.4 | ✅ | 🚀 |
| 🔍 Advanced Search Powerful search across the OSGi framework | 2.4.4 | ✅ | 🚀 |
| 🤖 MCP Support Model Context Protocol integration for AI agents. Read More | 2.4.5 | ✅ | 🚀 |
| 👻 Headless Launch Start application with pre-configured connection. Read More | 2.4.5 | ✅ | 🚀 |
| 🌐 JAX-RS View Inspect JAX-RS Applications, Resources, and Extensions | 3.0.0 | ✅ | 🚀 |
| 📦 CDI View Inspect CDI Containers, Components, and Extensions | 3.0.0 | ✅ | 🚀 |
| 🔐 Authentication & Security Password authentication with AES-256 encryption, TLS/SSL, and OAuth/Token support | 3.0.0 | ✅ | 🚀 |
| 💥 Blast Radius Analysis Pre-flight simulation of impact when stopping bundles or disabling components | 3.0.0 | ✅ | 🚀 |
| 🌊 Activation Cascade Analysis Predictive analysis of service activations and hijacking when starting bundles or enabling components | 3.0.0 | ✅ | 🚀 |
| 🐒 Chaos Monkey Resilience and fault-injection testing for bundles and components | 3.0.0 | ✅ | 🚀 |
| 🕵️ Conditions Monitor Inspect system conditions and inject/revoke mocks | 3.0.0 | ✅ | 🚀 |
| 🌍 Remote Services Admin Monitor OSGi Remote Services endpoints (imports and exports) with graph visualization | 3.1.0 | ✅ | 🚀 |
| 🤖 AI Command Builder AI-assisted Gogo command generation with Smart Match (BM25) and optional remote LLM (OpenAI, Gemini, Groq, Grok, Ollama) | 3.1.0 | ✅ | 🚀 |
💡 Troubleshooting & Tips
- 👻 Headless Mode: Starting from 2.4.5, need to connect without the connection wizard? Use the
-Dosgifx.config=/path/to/config.jsonsystem property to launch OSGi.fx with a pre-defined connection. See the Headless Launch Documentation. - 🤖 AI Assistance: OSGi.fx 2.4.5 supports the Model Context Protocol (MCP), allowing AI agents to connect to and debug your OSGi runtime directly! See the MCP Server Documentation.
- 🧠 AI Command Builder: Describe what you want in natural language and get the matching Gogo command instantly via Smart Match (BM25). Optionally configure a remote LLM (OpenAI, Gemini, Groq, Grok, Ollama, or any OpenAI-compatible API) for AI-powered command generation with parameter substitution.
👨💻 Maintainer
Amit Kumar Mondal (admin@amitinside.com)
🤝 Contributing 
Want to contribute? Great! Check out Contribution Guide
📄 License
This project is licensed under Apache License Version 2.0 