usage

package
v0.0.87 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 27, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FetchOptions added in v0.0.87

type FetchOptions struct {
	// GrokCommand overrides GROK_SHOW_USAGE_COMMAND.
	GrokCommand string
	// CodexCommand overrides CODEX_SHOW_STATUS_COMMAND.
	CodexCommand string
	// CodexSessionID overrides CODEX_SHOW_STATUS_SESSION_ID.
	CodexSessionID string
	// CodexTimeoutSeconds overrides CODEX_SHOW_STATUS_TIMEOUT when > 0.
	CodexTimeoutSeconds int
	// TTYWatchHome overrides TTY_WATCH_HOME (Codex).
	TTYWatchHome string
}

FetchOptions configures provider-specific hooks without process env mutation.

type ProviderID

type ProviderID string

ProviderID identifies a usage fetch provider.

const (
	Grok  ProviderID = "grok"
	Codex ProviderID = "codex"
)

type Snapshot

type Snapshot struct {
	Provider     ProviderID
	UsagePercent string
	Reset        string
	CreditsUsed  string
	CreditsTotal string
}

Snapshot is the normalized usage payload returned by Fetch.

func Fetch

func Fetch(ctx context.Context, id ProviderID) (*Snapshot, error)

Fetch retrieves usage for the given provider in-process.

func FetchWithOptions added in v0.0.87

func FetchWithOptions(ctx context.Context, id ProviderID, opts FetchOptions) (*Snapshot, error)

FetchWithOptions retrieves usage with explicit provider hooks (parallel-safe tests).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL