CherryHQ-cherry-studio/packages/provider-registry/README.md

@cherrystudio/provider-registry

Bundled AI provider and model catalog for Cherry Studio: static JSON data files plus TypeScript schemas for reading them.

Internal package — not published to npm. It's private and consumed only inside this monorepo (the app resolves it to src/ directly; the main process reads data/*.json from the bundled resources). The imports below are for in-repo consumers via the workspace, not an external install.

Contributing? The data/*.json files are generated — never hand-edit them. Edit src/creators/ / src/providers/ and run pnpm generate. See CLAUDE.md and docs/architecture.md.

Data Files

data/
  models.json            # Base model catalog (capabilities, limits, pricing)
  providers.json         # Provider configurations (endpoints, API features)
  provider-models.json   # Per-provider model overrides

Usage

import {
  readModelRegistry,
  readProviderRegistry,
  readProviderModelRegistry
} from '@cherrystudio/provider-registry/node'

const models = readModelRegistry('/path/to/models.json')
const providers = readProviderRegistry('/path/to/providers.json')
const overrides = readProviderModelRegistry('/path/to/provider-models.json')

Schema Types

import type {
  ProtoModelConfig,
  ProtoProviderConfig,
  ProtoProviderModelOverride,
  EndpointType,
  ModelCapability,
  Modality
} from '@cherrystudio/provider-registry'

Build

pnpm build