Skip to main content

Installation

Install the bundle into the target profile:

dsh plugin --profile <profile> add @dsh-ai-providers/all

The bundle installs the runtime plus the OpenAI, LocalAI, Anthropic, Ollama, Cohere, DashScope, Jina, and TypeSafe packages. Restart the profile after installation so DSH can load their configuration rows and settings pages.

The bundle does not add an assistant or send requests on its own. Configure the providers you need, then use a plugin that consumes their services.

Package roles​

@dsh-ai-providers/runtime owns the runtime services and provider selection. It does not make vendor API calls by itself. Vendor plugins register implementations with it at runtime.

For a custom deployment, activate the runtime first and then add only the desired provider packages:

dsh plugin --profile <profile> add @dsh-ai-providers/runtime
dsh plugin --profile <profile> add @dsh-ai-providers/localai

Every vendor package depends on the runtime package so its module is installed, but DSH activates bundle layers explicitly: installing a vendor does not implicitly enable the runtime bundle. Each vendor bundle contributes only its own row, so any number of providers can be combined without loading the runtime twice.

@dsh-ai-providers/core contains the contracts used by plugin authors and is pulled in by the runtime packages. Three implementation libraries are installed only as dependencies. @dsh-ai-providers/openai-compatible serves OpenAI and LocalAI and includes OpenAI's Decisions transport, @dsh-ai-providers/jina-cohere serves Jina and Cohere, and @dsh-ai-providers/systemone serves TypeSafe and LocalAI decisions. None of these libraries adds a DSH plugin row.

Requirements​

  • A DSH release accepted by the packages' engines.dsh range (currently >=0.2.0-rc.2 <0.2.1 || >=0.2.1-rc.2 <0.2.2)
  • Node.js 22 or later
  • A DSH profile with the web UI for interactive configuration

The OpenAI plugin works with OpenAI and compatible servers. Compatibility depends on which endpoints the server implements.

Verify the installation​

After restart, open DSH settings. A complete bundle installation shows one Providers page for every installed vendor's connections, followed by the language-model, capability, and concurrency pages. Provider-specific models and options appear inside the service they implement, not as vendor entries in the sidebar. If a provider is missing, confirm that its bundle row and the runtime are enabled in the same profile.

The runtime remains idle until a consumer calls a service. To verify an end-to-end setup, configure one connection, select it for one capability, then run the minimal example on that service's page or use an installed consumer plugin.

Upgrade and removal​

Upgrade the packages together so the runtime, core contract, and project-maintained providers stay on the same release. Restart the profile after changing installed package versions or bundle activation.

When upgrading from a release where @dsh-ai-providers/jina-cohere was a provider plugin, remove its old ai-jina-cohere profile row and install or enable @dsh-ai-providers/jina instead. Select Jina again for embedding or reranking and copy the old connection settings into the Jina connection. The jina-cohere package is now only a shared library and has no settings page or provider registration.

Removing a provider package removes its registered implementations and settings page. It does not remove credentials from DSH's credential store. Before removing the runtime, update or remove plugins that declare its services as required Cordis injections; otherwise DSH will correctly report the missing dependency.

Profile isolation​

Installation targets only the named DSH profile. Repeat the command for each profile that should expose these services, and configure its provider selections independently. Credential references may point to credentials managed by DSH, but the provider package does not copy secret values into profile configuration.