codexauth

package module

Go to main page

Versions in this module

v0

v0.4.0

Sep 4, 2026

Changes in this version

type Client

+ func (c *Client) ListModels(ctx context.Context, clientVersion string) ([]ModelCatalogEntry, error)

+ type ModelCatalogEntry struct

+ DefaultReasoningEffort *string

+ Description *string

+ DisplayName string

+ Priority int

+ Slug string

+ SupportedReasoningEfforts []ReasoningEffortOption

+ type ModelCatalogHTTPError struct

+ StatusCode int

+ func (e *ModelCatalogHTTPError) Error() string

+ type ReasoningEffortOption struct

+ Description string

+ Effort string

v0.3.0

Jun 7, 2026

Changes in this version

+ var ErrInsecureEndpoint = errors.New("codexauth: refusing cleartext http endpoint to non-loopback host")

type Options

+ CredentialPath string

+ Endpoint string

v0.2.0

May 26, 2026

Changes in this version

+ func ClassifyCodexError(err error) error

type Options

+ DevicePrompt func(verificationURI, userCode string) error

v0.1.1

May 26, 2026

v0.1.0

May 25, 2026

Changes in this version

+ const ClientID

+ const CodexEndpoint

+ const DeviceRedirectURI

+ const Issuer

+ const OAuthPort

+ const Originator

+ const PKCEMethod

+ const RedirectURI

+ const Scope

+ var ErrAuthorizationDenied = errors.New("codexauth: authorization denied")

+ var ErrNoBrowser = errors.New("codexauth: no browser launcher found")

+ var ErrNotLoggedIn = errors.New("codexauth: not logged in")

+ var ErrPlanNotIncluded = errors.New("codexauth: plan not included")

+ var ErrQuotaExceeded = errors.New("codexauth: quota exceeded")

+ var ErrRefreshFailed = errors.New("codexauth: refresh failed")

+ var ErrStateMismatch = errors.New("codexauth: OAuth callback state mismatch")

+ var Version = "0.0.0-dev"

+ func BuildAuthorizeURL(challenge, state string) string

+ func ChallengeFromVerifier(v string) string

+ func Delete(provider string) error

+ func ExtractAccountID(idToken string) string

+ func GenerateState() (string, error)

+ func GenerateVerifier() (string, error)

+ func HTTPClient(_ context.Context) (*http.Client, error)

+ func IsCodexAllowed(model string) bool

+ func Logout(ctx context.Context) error

+ func Path() (string, error)

+ func Save(af AuthFile) error

+ func StartCallbackServer(ctx context.Context, state string) (codeCh <-chan string, errCh <-chan error, shutdown func(), err error)

+ type AuthError struct

+ Code string

+ Description string

+ func (e *AuthError) Error() string

+ type AuthFile struct

+ Anthropic *json.RawMessage

+ OpenAI *Credentials

+ func Load() (AuthFile, error)

+ type Client struct

+ func NewClient(opts Options) *Client

+ func (c *Client) HTTPClient(_ context.Context) (*http.Client, error)

+ func (c *Client) Login(ctx context.Context, forceDevice bool) (Credentials, error)

+ func (c *Client) LoginBrowser(ctx context.Context) (Credentials, error)

+ func (c *Client) LoginDevice(ctx context.Context) (Credentials, error)

+ func (c *Client) Logout(ctx context.Context) error

+ func (c *Client) Path() (string, error)

+ func (c *Client) Status(ctx context.Context) (StatusInfo, error)

+ type Credentials struct

+ Access string

+ AccountID string

+ Expires int64

+ IDToken string

+ Refresh string

+ func ExchangeCode(ctx context.Context, code, verifier, redirectURI string) (Credentials, error)

+ func Login(ctx context.Context, forceDevice bool) (Credentials, error)

+ func LoginBrowser(ctx context.Context) (Credentials, error)

+ func LoginDevice(ctx context.Context) (Credentials, error)

+ func RefreshToken(ctx context.Context, refreshTok string) (Credentials, error)

+ func (c Credentials) LogValue() slog.Value

+ func (c Credentials) String() string

+ type DeviceError struct

+ Code string

+ Err error

+ Message string

+ func (e *DeviceError) Error() string

+ func (e *DeviceError) Unwrap() error

+ type Options struct

+ AppName string

+ CallbackPort int

+ Logger *slog.Logger

+ type PortInUseError struct

+ Addr string

+ Err error

+ func (e *PortInUseError) Error() string

+ func (e *PortInUseError) Unwrap() error

+ type StatusInfo struct

+ AccountID string

+ ConfigPath string

+ ExpiresAt time.Time

+ LoggedIn bool

+ Stale bool

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