usage

Documentation

Overview

Package usage provides access to the Anthropic quota usage API.

Index

• Variables
• func CountCompactions(transcriptPath string) int
• func ExhaustedResetMinutes(data *Data) int
• func FormatQuotaWindow(win *QuotaWindow, label string) string
• func FormatRateLimitSegment(minutes int) string
• func FormatStaleQuotaWindow(win *QuotaWindow, label string) string
• type Data
  • func Fetch() (*Data, error)
  • func FetchLastGood() *Data
  • func ParseBody(body []byte) (*Data, error)
• type ExtraUsage
• type QuotaWindow

Variables

var CachePath = "/tmp/claude-usage-cache.json"

CachePath is the path to the usage cache file. Replaceable for testing.

var CacheTTL = 10 * time.Minute

CacheTTL is the cache duration for usage data. Configurable at startup.

var HTTPGetFn httpclient.GetFn = httpclient.Get

HTTPGetFn is the function used for HTTP requests. Replaceable for testing.

var LastGoodCachePath = "/tmp/claude-usage-last-good.json"

LastGoodCachePath stores the last successful API response. Replaceable for testing.

Functions

func CountCompactions

func CountCompactions(transcriptPath string) int

CountCompactions counts compact_boundary entries in a session transcript JSONL.

func ExhaustedResetMinutes

func ExhaustedResetMinutes(data *Data) int

ExhaustedResetMinutes returns the reset time for the most saturated active window.

func FormatQuotaWindow

func FormatQuotaWindow(win *QuotaWindow, label string) string

FormatQuotaWindow formats a single quota window for display.

func FormatRateLimitSegment

func FormatRateLimitSegment(minutes int) string

FormatRateLimitSegment formats the explicit exhausted-limit segment.

func FormatStaleQuotaWindow

func FormatStaleQuotaWindow(win *QuotaWindow, label string) string

FormatStaleQuotaWindow formats a window with ?% but real time and indicator.

Types

type Data

type Data struct {
	FiveHour  *QuotaWindow
	SevenDay  *QuotaWindow
	Extra     *ExtraUsage
	ErrorType string
}

Data is the parsed response from Anthropic usage API.

func Fetch

func Fetch() (*Data, error)

Fetch retrieves quota usage from Anthropic API (with caching).

func FetchLastGood

func FetchLastGood() *Data

FetchLastGood returns the last successful usage data (no TTL).

func ParseBody

func ParseBody(body []byte) (*Data, error)

ParseBody parses the usage API response body.

type ExtraUsage

type ExtraUsage struct {
	MonthlyLimit float64
	UsedCredits  float64
}

ExtraUsage represents monthly extra/overuse budget.

type QuotaWindow

type QuotaWindow struct {
	Utilization      float64
	ResetsAt         time.Time
	TotalMinutes     int
	RemainingMinutes int
}

QuotaWindow represents a single usage quota window (5-hour or 7-day).