codex

Documentation

Overview

Package codex implements the Codex OAuth API usage provider.

Reads credentials from ~/.codex/auth.json (or $CODEX_HOME/auth.json), hits {base}/wham/usage for session/weekly metrics and credits balance, where {base} honors a chatgpt_base_url override in the Codex config (~/.codex/config.toml or $CODEX_HOME/config.toml) — matching the Codex CLI's own override plumbing — and defaults to chatgpt.com.

Index

• type Provider
  • func (Provider) BrandBg() string
  • func (Provider) BrandColor() string
  • func (Provider) Fetch(_ providers.FetchContext) (providers.Snapshot, error)
  • func (Provider) ID() string
  • func (Provider) MetricIDs() []string
  • func (Provider) Name() string

Types

type Provider

type Provider struct{}

Provider fetches Codex usage data.

func (Provider) BrandBg

func (Provider) BrandBg() string

BrandBg returns the background color used on button faces.

func (Provider) BrandColor

func (Provider) BrandColor() string

BrandColor is deep indigo #3941FF — the bottom stop of the lavender→ indigo gradient used on the loading reference card. A single hex (rather than a runtime gradient) keeps Codex's rendered buttons visually uniform with every other provider; the gradient only survives on the pre-data loading SVG as a subtle brand accent.

func (Provider) Fetch

func (Provider) Fetch(_ providers.FetchContext) (providers.Snapshot, error)

Fetch returns the latest Codex usage snapshot using the browser-proxied path when available and the OAuth direct path otherwise.

func (Provider) ID

func (Provider) ID() string

ID returns the provider identifier used by the registry.

func (Provider) MetricIDs

func (Provider) MetricIDs() []string

MetricIDs enumerates every metric this provider can emit.

func (Provider) Name

func (Provider) Name() string

Name returns the human-readable provider name.