cli

Documentation

Overview

Package cli implements the codex-usage commands.

Index

• Constants
• func ColorEnabled(f *os.File) bool
• func IsTerminal(f *os.File) bool
• type App
  • func (a *App) Run(ctx context.Context, args []string) int

Constants

const (
	AuthBaseURLEnvVar    = "CODEX_USAGE_AUTH_BASE_URL"
	ChatGPTBaseURLEnvVar = "CODEX_USAGE_CHATGPT_BASE_URL"
)

Environment variables that point the CLI at other servers, for testing.

const ClaudeBinEnvVar = "CODEX_USAGE_CLAUDE_BIN"

ClaudeBinEnvVar overrides the Claude Code binary; "off" turns Claude Code support off.

Functions

func ColorEnabled

func ColorEnabled(f *os.File) bool

ColorEnabled reports whether ANSI colors should be written to f.

func IsTerminal

func IsTerminal(f *os.File) bool

IsTerminal reports whether f is a terminal.

Types

type App

type App struct {
	Version     string
	Stdin       io.Reader
	Stdout      io.Writer
	Stderr      io.Writer
	Getenv      func(string) string
	HTTPClient  *http.Client
	Now         func() time.Time
	Location    *time.Location
	OpenBrowser func(url string) error
	Color       bool
	// Environ is the environment passed on to Claude Code.
	Environ func() []string
	// StdoutTerminal is set when stdout is a terminal rather than a pipe.
	StdoutTerminal bool
}

App holds the process environment; zero fields get working defaults.

func (*App) Run

func (a *App) Run(ctx context.Context, args []string) int

Run executes the command line and returns the process exit code.