Connect the AI setup you already have to the coding assistant you want to use.
Get started · See the real screens · Get help
Real, user-supplied screens. Personal details removed. View full-size screenshots and capture notes.
You have already connected your AI providers in OmniRoute. You should not have to repeat that setup just to use them in Oh My Pi.
OMP OmniRoute Provider is the plugin that connects the two. Enter your gateway address and access key through guided prompts, choose a model your gateway makes available, and work inside OMP. Your provider accounts and routing stay in OmniRoute.
You do not need to edit configuration files for the normal guided connection. Install the plugin, restart OMP, and follow the setup prompts.
Point OMP at your existing gateway. The plugin uses the models exposed by that gateway, rather than asking you to configure every underlying provider again inside OMP.
Discover the chat models available to your connection. When you change what the gateway exposes, refresh the list in OMP. Optional model information can enrich those entries without inventing models you cannot actually run.
Connect, choose a model, and get to work. Additional model information, pricing views, and administration are optional. You do not need to enable them to use the basic connection.
| Part | Its job |
|---|---|
| Oh My Pi, or OMP | The AI coding assistant you use in your terminal. |
| OmniRoute | The separate gateway where your AI providers and routing are configured. |
| This plugin | The connection between OMP and that gateway, with guided setup and model discovery. |
This is an OMP plugin, not an OmniRoute server. It does not install the gateway or create provider accounts for you. It connects to the gateway you already use, whether you run it yourself or have access to one managed for you.
Have OMP installed, a working OmniRoute gateway, and the gateway's address and runtime API key ready. The runtime key is the access key OMP will use for model requests. It is not automatically an administration credential.
New to either tool? Start with Oh My Pi and OmniRoute, then return here to connect them. The declared OMP compatibility range for this plugin is >=18.12.2 <19; see compatibility notes for the distinction between that range and tested releases.
Run this in your normal terminal, outside an OMP conversation:
omp plugin install https://github.com/CruxExperts/OMP-OmniRoute-Provider#v1.0.3Close and restart OMP after installation. This command installs the tagged GitHub source; there is no npm-registry installation step for this release.
Inside OMP, enter:
/omniroute setup
Open Connection. Enter your gateway address and its runtime API key. The key prompt is masked. Setup checks the connection, verifies the key, and checks the gateway's live model list before activating the connection.
Use the address for your own gateway. The example https://llm.example.com is only an example, not a service included with this plugin. For an address that intentionally uses HTTP, include http:// explicitly; see the connection guide for details.
Leave the optional sections alone for your first connection. You can return to them later.
Already using OMP's /login menu?
Look for Crux OmniRoute Provider in the provider selector. That is the name shown inside OMP; OMP OmniRoute Provider is the project's name.
The screenshots show this native /login path. The recommended /omniroute setup command opens the plugin's own guided setup instead.
OMP may briefly display “Starting OAuth flow…” in its native login screen. This provider still uses your gateway's API key; that generic host message does not mean you need a browser-based OAuth login. More about that message.
Use OMP's model selector to choose one of the models discovered from your OmniRoute connection. The available choices depend on what your gateway and credentials expose.
Check the connection at any time:
/omniroute
You now have OMP as your working interface and OmniRoute handling the gateway side. Choose your task and continue in OMP.
Prefer choosing a model from the terminal?
List the models from your normal terminal:
omp models --jsonThen start OMP with the full model selector returned by that list. The following shows the format; replace <live-model-id> with a real discovered model ID rather than pasting the placeholder literally:
omp --model omniroute/<live-model-id>
Stuck at a step? Open the troubleshooting guide.
These are real screens from a user-provided OMP session, not recreated interfaces. Terminal title bars and outer edges have been removed. The full terminal viewport is preserved in each downloadable screenshot, with only identified privacy areas edited.
The native sign-in screen asks for your gateway address, followed by its API key. The example addresses shown are guidance, not preconfigured connections.
See all six OMP screens, the gateway screen, and full-size sanitized captures →
You only need a few plugin commands for routine work. Enter these inside OMP.
| You want to… | Use this |
|---|---|
| Connect or change setup options | /omniroute setup |
| Check the current connection and model information | /omniroute |
| Refresh models after changes in OmniRoute | /omniroute refresh |
| Inspect optional configured pricing information | /omniroute-pricing |
The earlier /cruxomni, /cruxomni-admin, and /cruxomni-pricing names remain supported aliases. You do not need to rename saved credentials or start over.
Enable optional catalogs to add available model details to the models your gateway already exposes. Catalogs do not add runnable models, install AI models on your computer, or replace the gateway's live model list.
An optional source-backed pricing view can show information from a configured pricing file. Missing prices remain unknown, not “free.” This is not a promise of live billing, a spending limit, or an automatically cheaper route.
For users managing their own gateway, the plugin also offers a separate administration workflow. Supported changes are previewed and require explicit confirmation. Administration uses a separate management credential; installing the plugin or signing in for chat does not automatically grant permission to change the server.
Administration is optional and covers selected operations, not the entire OmniRoute dashboard. Read the administration guide and current operation inventory before enabling it.
Administration entry points
Enter these inside OMP when you are ready to use the separate administration workflow:
/omniroute-admin status
/omniroute-admin enable
/omniroute-admin search
/omniroute-admin disable
Configure the separate credential through setup before enabling administration. Check an operation's availability, inspect its preview, and confirm only the change you intend. An uncertain response is not proof of success; follow the guide's recovery instructions rather than blindly repeating it.
Your runtime API key is handled through OMP's native credential storage after successful connection checks. Optional metadata and administration credentials can be kept for the current session or remembered in OMP's credential store, according to the option you choose.
OMP sends model requests through the gateway you configure. Which providers handle those requests depends on your OmniRoute setup. Self-hosting a gateway does not, by itself, mean that every model runs locally.
Read what is stored · Read the security policy
Do I need to be a developer?
You do not need to edit the plugin's code or hand-write configuration files for the normal setup. You do need OMP, access to an already-working gateway, and the ability to run the install command. The guided prompts handle the connection details.
Is it free?
The plugin's source code and documentation are MIT licensed. Using AI models, provider accounts, and hosting may carry their own costs. The visual assets have a separate project-reference display license.
Does this replace OmniRoute or change my provider setup?
No. OmniRoute remains the separate gateway. Your provider accounts and routing remain there. The plugin brings the models available to that connection into OMP. Optional administration is a separate workflow that you deliberately enable.
Why does the menu say “Crux OmniRoute Provider”?
That is the plugin's label in OMP's login menu. The public project name is OMP OmniRoute Provider. The underlying provider ID remains omniroute, which preserves the existing model and credential identity.
Why is a model missing?
Run /omniroute refresh, then check the gateway and the key you connected with. Only compatible chat models returned by the gateway's live catalog become selectable. A model appearing in an optional information catalog does not make it available to your connection.
Can I use local models?
The relevant question is whether your gateway exposes the model through a supported chat connection. The plugin does not download model weights or turn every locally installed model into an OMP option. Check the live model list and the gateway configuration.
| Item | Reference for this README |
|---|---|
| Tagged plugin installation | v1.0.3 |
| Declared OMP range | >=18.12.2 <19 |
| Distribution | GitHub release assets and tagged GitHub source |
| Optional administration | Availability is defined by the current operation inventory |
A declared version range is not the same as a completed test matrix. The supplied startup screenshot displays OMP 18.12.6, while the repository's generated reference lists 18.12.2, 18.12.5, and 18.12.6 as its requested host test matrix. A screenshot is not a substitute for release verification. The gateway screenshot displays 3.8.51 and a customized label; it is an illustration of that user's setup, not a claim to show the latest OmniRoute release.
Compatibility reference · Changelog · Upgrade or remove the plugin
Start with the installation guide, everyday-use guide, or troubleshooting guide.
For a problem you cannot resolve, open an issue. Include the plugin version, OMP version, the command you used, and the sanitized error message. Remove keys, cookies, personal addresses, account details, and private workspace information before posting.
Use the process in SECURITY.md for sensitive security reports. Support information explains the project's support channels.
For contributors and maintainers
Start with CONTRIBUTING.md, the generated command reference, and the branding and naming policy.
Source development requires Bun >=1.4.2. The normal user installation above is different from linking a development checkout:
bun install --frozen-lockfile --ignore-scripts
omp plugin link "$PWD"Restart OMP after changing a development link. Keep public display names separate from package IDs, command aliases, and stored-credential identities.
Built and maintained by Crux Experts LLC.
Independent plugin for Oh My Pi and OmniRoute. No upstream endorsement is implied.
Source and documentation: MIT · Visual assets: separate project-reference license · Third-party notices