Skip to content

provider-template

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

provider-template

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
config.test.ts
config.test.ts
 
 
config.ts
config.ts
 
 
provider.test.ts
provider.test.ts
 
 
provider.ts
provider.ts
 
 

README.md

Provider template

Copy this folder when adding a provider that should use the README wording:

Existing OpenCode auth, global config, or env

This template is intentionally outside src/ and is not published to npm. package.json only publishes dist, README.md, and LICENSE.

Who this is for

Use this template for API-key/token providers that support all three trusted sources:

  1. existing OpenCode API-key/token auth (auth.json)
  2. trusted user/global OpenCode config
  3. environment variables

Do not use it for OAuth-only providers such as OpenAI.

Copy targets

Template file Copy to Purpose
config.ts src/lib/<provider>-config.ts Resolve auth from OpenCode auth, global config, and env.
provider.ts src/providers/<provider>.ts Register availability, model matching, and quota fetch mapping.
config.test.ts tests/lib.<provider>-config.test.ts Prove auth source precedence/fallbacks.
provider.test.ts tests/providers.<provider>.test.ts Prove provider wrapper behavior.

Also update:

  • src/lib/provider-metadata.ts
  • src/providers/registry.ts
  • README.md
  • /quota_status diagnostics when the provider exposes auth-source details

Replacement checklist

Before coding, replace these placeholders everywhere:

  • example-provider
  • Example Provider
  • EXAMPLE_PROVIDER_API_KEY
  • exampleProvider
  • exampleProviderProvider
  • queryExampleProviderQuota

README wording rule

Use Existing OpenCode auth, global config, or env only after tests prove all three paths work. Do not leave copied template tests skipped, todo-only, or unresolved. If one path is missing, use provider-specific wording instead.