Metadata-Version: 2.4
Name: ollabridge
Version: 0.1.4
Summary: Turn your PC into a private, OpenAI-compatible LLM provider in ~60 seconds
Project-URL: Homepage, https://github.com/ruslanmv/ollabridge
Project-URL: Documentation, https://github.com/ruslanmv/ollabridge#readme
Project-URL: Repository, https://github.com/ruslanmv/ollabridge
Project-URL: Issues, https://github.com/ruslanmv/ollabridge/issues
Project-URL: Changelog, https://github.com/ruslanmv/ollabridge/releases
Author-email: Ruslan Magana Vsevolodovna <contact@ruslanmv.com>
Maintainer-email: Ruslan Magana Vsevolodovna <contact@ruslanmv.com>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: ai,api,chatgpt,deepseek,embeddings,gateway,langchain,llama,llm,local-first,machine-learning,ollama,openai,self-hosted
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: anyio
Requires-Dist: cryptography>=42.0
Requires-Dist: fastapi>=0.110
Requires-Dist: httpx>=0.26
Requires-Dist: itsdangerous>=2.1
Requires-Dist: pydantic-settings>=2.2
Requires-Dist: pydantic>=2.6
Requires-Dist: python-dotenv>=1.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.7
Requires-Dist: slowapi
Requires-Dist: sqlalchemy
Requires-Dist: sqlmodel
Requires-Dist: tenacity>=8.2
Requires-Dist: typer>=0.12
Requires-Dist: uvicorn[standard]>=0.27
Requires-Dist: websockets>=12.0
Provides-Extra: dev
Requires-Dist: black>=23.7; extra == 'dev'
Requires-Dist: mypy>=1.4; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
Requires-Dist: pytest-cov>=4.1; extra == 'dev'
Requires-Dist: pytest>=7.4; extra == 'dev'
Requires-Dist: ruff>=0.0.280; extra == 'dev'
Provides-Extra: notebook
Requires-Dist: ipykernel>=7.1.0; extra == 'notebook'
Requires-Dist: openai>=2.14.0; extra == 'notebook'
Requires-Dist: python-dotenv>=1.2.1; extra == 'notebook'
Requires-Dist: requests>=2.32.5; extra == 'notebook'
Description-Content-Type: text/markdown

<div align="center">

<img src="assets/logo.svg" alt="OllaBridge Logo" width="500"/>

# OllaBridge ⚡️

**Bring your own LLMs, devices, GPUs, and provider accounts.
Use them securely from anywhere through one OpenAI-compatible API.**

[![PyPI version](https://badge.fury.io/py/ollabridge.svg)](https://badge.fury.io/py/ollabridge)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[Quick Start](#-60-second-start) • [The Dashboard](#%EF%B8%8F-the-dashboard) • [Why OllaBridge](#-why-teams-choose-ollabridge) • [Local vs Cloud vs Enterprise](#-local-vs-cloud-vs-enterprise) • [Docs](#-documentation)

<img src="docs/assets/screenshots/dashboard.png" alt="OllaBridge Dashboard — live routing control tower" width="100%"/>

*The OllaBridge control tower: your models, devices, providers, and cloud relay — live, in one place.*

</div>

---

## 🎯 What is OllaBridge?

> **One gateway. All your LLMs. Everywhere.**

OllaBridge turns your PC into a **private, OpenAI-compatible LLM provider in ~60 seconds** — and grows with you into a hybrid control plane for every model you can reach: local Ollama, remote GPUs, your team's workstations, and your own OpenAI/Anthropic/Gemini accounts.

**The problem:** your models live everywhere (laptop, cloud GPU, gaming PC, hosted APIs), and every app needs a different endpoint, key, and config.

**The OllaBridge answer:** apps connect to **one URL with one key**. OllaBridge routes each request to the right compute — and can always tell you exactly where it went.

```mermaid
graph TB
    A[Your Apps] -->|OpenAI SDK| B[OllaBridge<br/>Control Plane]

    B -->|Auto Routes| C[Local Laptop<br/>llama3.1]
    B -->|Auto Routes| D[Free GPU Cloud<br/>deepseek-r1]
    B -->|Auto Routes| E[Remote Workstation<br/>mixtral]

    C -.->|Dials Out| B
    D -.->|Dials Out| B
    E -.->|Dials Out| B

    style B fill:#6366f1,stroke:#4f46e5,stroke-width:3px,color:#fff
    style A fill:#10b981,stroke:#059669,stroke-width:2px,color:#fff
    style C fill:#8b5cf6,stroke:#7c3aed,stroke-width:2px,color:#fff
    style D fill:#ec4899,stroke:#db2777,stroke-width:2px,color:#fff
    style E fill:#f59e0b,stroke:#d97706,stroke-width:2px,color:#fff
```

**Key innovation:** compute nodes **dial out** to your gateway over outbound WebSockets. No port forwarding, no VPN, no config hell — your gaming PC at home can serve your laptop at a coffee shop.

---

## ⚡ 60-Second Start

```bash
pip install ollabridge
ollabridge start
```

That's it — Ollama is installed if needed, a model is pulled, an API key is generated, and your OpenAI-compatible endpoint is live at `http://localhost:11435/v1`.

Building from source? Two commands give you the full product, backend **and** dashboard:

```bash
make install      # backend + frontend into .venv (never touches system Python)
make run          # gateway + dashboard at http://localhost:11435/ui
```

Then point any OpenAI SDK at it:

```python
from openai import OpenAI

client = OpenAI(
    base_url="http://localhost:11435/v1",
    api_key="sk-ollabridge-...",   # printed at startup
)

print(client.chat.completions.create(
    model="llama3.1",
    messages=[{"role": "user", "content": "Hello!"}],
).choices[0].message.content)
```

Works out of the box with the OpenAI SDK, LangChain, Node.js, cURL — anything that speaks the OpenAI API. More in **[docs/EXAMPLES.md](docs/EXAMPLES.md)**.

---

## 🖥️ The Dashboard

A real-time command center for your entire LLM infrastructure — models, sources, devices, and the cloud relay, all visualized live at **`http://localhost:11435/ui`**.

### 🎛️ Share exactly what you choose — per model

Every model gets its own independent switches: **This PC · Cloud · per-app allow-lists · Routing**. Nothing leaves your machine until you flip a switch, and the *Published to OllaBridge Cloud* panel always shows precisely what your paired apps can see — no surprises, no hidden catalog.

<img src="docs/assets/screenshots/models-access.png" alt="Models &amp; Access — per-model sharing controls: This PC, LAN, Cloud, allowed apps, routing" width="100%"/>

<div align="center">

*One model published to the cloud and scoped to a single app — the others stay private to this PC. Safe by default, opt-in by design.*

</div>

### 🔌 Every AI account in one hub

Connect **OpenAI, Anthropic, Google Gemini, IBM watsonx.ai, Azure OpenAI, AWS Bedrock, Groq, Mistral** and more — 14 providers plus any OpenAI-compatible endpoint — with one uniform **add → test → rotate → remove** flow. Keys are encrypted at rest, stored on *your* machine, and never echoed back. New sources start local-only, private, and routing-off.

<img src="docs/assets/screenshots/sources-hub.png" alt="External Sources hub — 14 providers including IBM watsonx.ai, uniform add/test/rotate/remove, keys encrypted and local" width="100%"/>

<div align="center">

*Sources are peers, not modes — local Ollama and enterprise APIs side by side, each with its own keys, models, and sharing scope.*

</div>

### ☁️ Pair once, reach your models anywhere

| Cloud Relay | Device Pairing |
|---|---|
| <img src="docs/assets/screenshots/cloud.png" alt="Cloud Relay page — live connection, shared models, device identity"/> | <img src="docs/assets/screenshots/pairing.png" alt="Pairing page — link devices with short codes"/> |

| Model Inventory | Local Runtimes |
|---|---|
| <img src="docs/assets/screenshots/models.png" alt="Models page — local model catalog with capability detection"/> | <img src="docs/assets/screenshots/runtimes.png" alt="Local Runtimes — Ollama and HomePilot execution backends with per-runtime enable toggles"/> |

<details>
<summary>More screens: Providers Hub, Settings &amp; classic Sources</summary>

| Providers Hub | Settings |
|---|---|
| <img src="docs/assets/screenshots/providers.png" alt="Providers Hub — BYOK provider routing with encrypted key storage"/> | <img src="docs/assets/screenshots/settings.png" alt="Settings page"/> |

| Sources (classic) | |
|---|---|
| <img src="docs/assets/screenshots/sources.png" alt="Sources page (classic)"/> | |

</details>

```bash
# Install frontend dependencies
make ui-install

# Development (hot-reload, proxied to OllaBridge API)
make ui-dev

# Production build (served at /ui when gateway is running)
make ui-build
```

Once built, the dashboard is served at **`http://localhost:11435/ui`** whenever the gateway runs. React 19 + TypeScript + Vite, TanStack Query live polling, Framer Motion animation.

<p align="center">
  <img src="assets/dashboard-tower.svg" alt="OllaBridge Dashboard – Broadcast Tower" width="720" />
</p>

---

## 🚀 Why Teams Choose OllaBridge

| | |
|---|---|
| 🔒 **Local-first by default** | No cloud login, no telemetry, no prompt logging. Prompts, responses, and keys stay on your machine unless *you* decide otherwise. |
| 🎛️ **Per-model sharing controls** | Decide model by model what's visible where — this PC, the cloud, a specific app. Publishing is explicit, scoped, and always inspectable. |
| 🎯 **One source of truth** | Every app, every device, one OpenAI-compatible URL. Models can move between machines — your code never changes. |
| 🌍 **Any GPU, anywhere** | Nodes dial out — add a gaming PC, a Colab notebook, or a fleet of cloud GPUs in one command each. See [docs/SCALING.md](docs/SCALING.md). |
| 🔑 **Secure BYOK provider hub** | Bring your own OpenAI, Anthropic, Gemini, Groq, Bedrock, Mistral keys and more — encrypted at rest, redacted everywhere, routed across your authorized devices and workspaces. See [docs/PROVIDER_KEYS.md](docs/PROVIDER_KEYS.md). |
| ☁️ **Optional cloud relay** | `ollabridge login` pairs your device with OllaBridge Cloud so your models are reachable from anywhere — metadata-only sync, verifiable end to end. |
| 🧭 **Enterprise-grade trust** | `ollabridge doctor` verifies every link in the chain. Request tracing, policy routing, RBAC interfaces, audit posture — built in, documented, tested. See [docs/ENTERPRISE.md](docs/ENTERPRISE.md). |

---

## 🧭 Local vs Cloud vs Enterprise

OllaBridge is **local-first**. Cloud is optional. Enterprise builds on both.

| Mode | What runs | What leaves your machine | How to enable |
|---|---|---|---|
| **Local** (default) | OpenAI-compatible gateway on `localhost:11435` | Nothing. No cloud login, no telemetry, no prompt logging. | `ollabridge start` |
| **Cloud** (optional) | Local gateway + outbound relay to OllaBridge Cloud | Metadata only by default: device status, model names, routing profiles, health metrics. Never prompts, responses, or provider keys. | `ollabridge login` |
| **Enterprise** | Cloud orgs, fleet enrollment, shared policies | Same metadata rules, org-scoped; bootstrap tokens for fleet provisioning | See [docs/ENTERPRISE.md](docs/ENTERPRISE.md) |

```bash
ollabridge start          # local only — no cloud required
ollabridge login          # optional: pair with OllaBridge Cloud
ollabridge sync status    # see exactly what syncs (and what never does)
ollabridge sync disable   # turn all cloud sync off
ollabridge logout         # unpair and delete credentials
```

**The privacy contract** ([docs/PRIVACY.md](docs/PRIVACY.md), [docs/CLOUD_SYNC.md](docs/CLOUD_SYNC.md)): prompt content, conversation history, provider API keys, RAG documents, and persona memory are **never** synced unless you explicitly enable each one — and they are all off by default.

---

## 🩺 Trust, Verified — `ollabridge doctor`

You should never have to *hope* your AI infrastructure works. Verify it:

```bash
ollabridge doctor             # all checks, human-readable or --json
ollabridge doctor relay       # WSS connect, register, ping/pong, reconnect
ollabridge doctor e2e         # full request path with latency breakdown
ollabridge doctor security    # secrets at rest, permissions, auth, CORS
```

```
Relay:
  ✅ WSS connection established — wss://app.ollabridge.com/relay/connect
  ✅ Device registered — hello accepted
  ✅ Model list sent — 1 models
  ✅ Ping/pong — app-level heartbeat OK
  ✅ Reconnect test — second connection accepted
```

Every request carries a `request_id` (`X-Request-ID`), and the trace store records **routing metadata only — never prompt content**:

```bash
ollabridge traces list        # which model answered, was cloud used, latency
ollabridge route explain coding   # which backend WOULD serve this alias, and why
```

Policy aliases (`local-private`, `fast`, `cheap`, `best`, `coding`, …) are explicit and explainable — `local-private` is fail-closed: local devices only, no external providers, no relay, no prompt logging. Details: [docs/RELAY_VERIFICATION.md](docs/RELAY_VERIFICATION.md).

---

## 🔑 BYOK Providers

Secure BYOK routing across your authorized devices and workspaces — keys encrypted at rest (`OLLA_SECRET`), never printed, never synced by default:

```bash
ollabridge providers add anthropic     # choose: local-only / cloud vault / org vault
ollabridge providers test anthropic    # validates the key — no tokens spent
ollabridge providers rotate anthropic  # replace key, stamp rotation time
ollabridge providers list              # keys always redacted
```

Supported: **OpenAI, Anthropic, Gemini, Azure OpenAI, AWS Bedrock, Groq, OpenRouter, Hugging Face, DeepSeek, Mistral, Together, Fireworks**, plus any generic OpenAI-compatible endpoint. Free-tier alias routing (`free-best`, `free-fast`) via the [Providers Hub](docs/PROVIDERS_HUB.md).

---

## 🏗️ Architecture

<p align="center">
  <img src="assets/diagrams/architecture.svg" alt="OllaBridge end-to-end architecture: local gateway, Providers Hub, Hugging Face Inference Providers, and OllaBridge Cloud" width="100%" />
</p>

- **Gateway (control plane)** — FastAPI server exposing `/v1/*`, the dashboard, and admin APIs
- **Nodes (compute plane)** — Ollama/HomePilot/provider adapters that dial out over WebSockets
- **Cloud relay (optional)** — outbound-only WSS bridge so your devices are reachable from anywhere, tenant-isolated per account

Deep dives: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) • [docs/SCALING.md](docs/SCALING.md) • [docs/THREAT_MODEL.md](docs/THREAT_MODEL.md)

---

## 🤖 AI-Agent Native

OllaBridge ships an **MCP server** so AI agents can manage your infrastructure — create enrollment tokens, list runtimes, check health — through the Model Context Protocol:

```bash
ollabridge-mcp        # stdio MCP server for Claude Desktop, IDEs, agents
```

See [docs/MCP.md](docs/MCP.md).

---

## 📚 Documentation

| Getting started | Operations | Security & Enterprise |
|---|---|---|
| [Quickstart](docs/QUICKSTART.md) | [CLI Reference](docs/CLI.md) | [Security Policy](docs/SECURITY.md) |
| [Tutorial](docs/TUTORIAL.md) | [API Reference](docs/API.md) | [Privacy](docs/PRIVACY.md) |
| [Examples (SDKs, LangChain, cURL)](docs/EXAMPLES.md) | [Configuration & Auth](docs/CONFIGURATION.md) | [Threat Model](docs/THREAT_MODEL.md) |
| [Install Guide](INSTALL.md) | [Scaling & Public Access](docs/SCALING.md) | [Deployment Hardening](docs/DEPLOYMENT_HARDENING.md) |
| | [Relay Verification](docs/RELAY_VERIFICATION.md) | [Enterprise Architecture & RBAC](docs/ENTERPRISE.md) |
| | [Cloud Sync](docs/CLOUD_SYNC.md) | [Provider Keys (BYOK)](docs/PROVIDER_KEYS.md) |
| | [Providers Hub](docs/PROVIDERS_HUB.md) | [Enterprise Readiness Audit](docs/AUDIT_ENTERPRISE_READINESS.md) |
| | [HomePilot Integration](docs/HOMEPILOT.md) | [Enterprise Roadmap](docs/ROADMAP_ENTERPRISE.md) |
| | [MCP / AI Agents](docs/MCP.md) | |
| | [Local Model Catalog](docs/LOCAL_CATALOG.md) | |

---

## 🗺️ Roadmap

- [x] Control plane + dial-out node architecture (no port forwarding)
- [x] Web dashboard (Broadcast Tower visualization)
- [x] Optional cloud pairing + relay with end-to-end verification (`doctor relay`, `doctor e2e`)
- [x] Explicit, metadata-only cloud sync with privacy-first defaults
- [x] BYOK provider hub with encrypted key storage, rotation, and redaction
- [x] Policy routing with explainable aliases (`route explain`)
- [x] Request tracing without prompt content
- [x] Multi-provider free-tier routing (score-based selection)
- [x] HomePilot persona integration • MCP server for AI agents
- [ ] 🚧 Cloud encrypted vault & organization vault APIs
- [ ] 🚧 Relay streaming (`delta`/`done` frames end to end)
- [ ] 🚧 Prometheus metrics • more runtimes (vLLM, llama.cpp, LM Studio)

Full phased plan with shipped/planned status: [docs/ROADMAP_ENTERPRISE.md](docs/ROADMAP_ENTERPRISE.md)

---

## 🤝 Contributing

We welcome contributions! Areas we'd love help with: runtime adapters (vLLM, llama.cpp), monitoring/metrics, security reviews, docs.

1. Fork the repo
2. Create a branch (`git checkout -b feature/amazing`)
3. Make your changes and add tests (`make install-dev && make test`)
4. Submit a PR

---

## 📄 License

Apache License 2.0 — see [LICENSE](LICENSE)

## 🙏 Built With

[FastAPI](https://fastapi.tiangolo.com/) • [Ollama](https://ollama.ai/) • [WebSockets](https://websockets.readthedocs.io/) • [SQLModel](https://sqlmodel.tiangolo.com/) • [React](https://react.dev/) + [Vite](https://vitejs.dev/)

## 💬 Support

📖 [Documentation](docs/) • 🐛 [Report a Bug](https://github.com/ruslanmv/ollabridge/issues) • 💡 [Request a Feature](https://github.com/ruslanmv/ollabridge/issues) • 💬 [Discussions](https://github.com/ruslanmv/ollabridge/discussions)

## 🌟 Star History

If OllaBridge helped you, give it a star! ⭐

---

## Compatible with HomePilot

<p align="center">
  <a href="https://github.com/ruslanmv/HomePilot">
    <img src="assets/homepilot-logo.svg" alt="HomePilot" width="300" />
  </a>
</p>

OllaBridge is the recommended gateway for [HomePilot](https://github.com/ruslanmv/HomePilot) personas. Route `persona:*` and `personality:*` models to HomePilot while serving local LLMs via Ollama — all through a single OpenAI-compatible endpoint. Setup: [docs/HOMEPILOT.md](docs/HOMEPILOT.md).

<p align="center">
  <img src="assets/ollabridge-architecture.svg" alt="OllaBridge Architecture" width="800" />
</p>

Connect [3D Avatar Chatbot](https://github.com/ruslanmv/3D-Avatar-Chatbot) for an immersive VR persona experience with lip sync, gestures, and voice.

<p align="center">
  <img src="assets/3d-avatar-pipeline.svg" alt="3D Avatar + HomePilot Pipeline" width="800" />
</p>

---

<div align="center">

**Made with ❤️ for the local-first AI community**

**Stop paying cloud tokens. Use your own compute.**

</div>
