ax

package module

Go to main page

Versions in this module

v0

v0.5.0

Aug 30, 2026

Changes in this version

+ func ApprovalFromContext(ctx context.Context) bool

+ func AuditEnabledFromContext(ctx context.Context) bool

+ func GuardWithAudit(ctx context.Context, description string, effect func(context.Context) error) (bool, error)

+ func PerformWithAudit(ctx context.Context, description string, ...) error

+ func WithApproval(ctx context.Context, granted bool) context.Context

+ func WithAudit(ctx context.Context, enabled bool) context.Context

+ type ConfirmationOutcome uint8

+ const ConfirmationApproved

+ const ConfirmationBlocked

+ const ConfirmationPromptRequired

+ func Confirm(ctx context.Context, subject string) (ConfirmationOutcome, error)

v0.4.0

Jul 24, 2026

Changes in this version

+ const DefaultHTTPTimeout

+ func NewHTTPClient(opts ...HTTPClientOption) *http.Client

+ func WithNonDeterministicFields[T any](cmd *cobra.Command)

+ type HTTPClientOption func(*httpClientConfig)

+ func WithHTTPTimeout(d time.Duration) HTTPClientOption

v0.3.0

Jun 30, 2026

Changes in this version

+ func Guard(ctx context.Context, effect func(context.Context) error) (bool, error)

+ func Perform(ctx context.Context, rehearse, commit func(context.Context) error) error

type ErrorOption

+ func WithRetryAfterSeconds(seconds int64) ErrorOption

+ func WithRetryable(retryable bool) ErrorOption

v0.2.0

Jun 21, 2026

v0.1.0

Jun 19, 2026

Changes in this version

+ func Flush(ctx context.Context, l Logger) error

type LoggerOption

+ func WithLokiFromEnv() LoggerOption

v0.0.2

Jun 13, 2026

Changes in this version

+ func PatchConfig(ctx context.Context, r io.Reader, patch []byte, opts ...ParseConfigOption) ([]byte, error)

+ func PatchConfigFile(ctx context.Context, path string, patch []byte, opts ...ParseConfigOption) error

type TelemetryOption

+ func WithTelemetryServiceName(name string) TelemetryOption

+ func WithTelemetryServiceVersion(version string) TelemetryOption

+ func WithTelemetryShutdownBudget(d time.Duration) TelemetryOption

+ func WithTelemetryStderr(w io.Writer) TelemetryOption

v0.0.1

Jun 11, 2026

Changes in this version

+ const DefaultMaxConfigBytes

+ const ErrorSchemaVersion

+ const ExitAuth

+ const ExitInternal

+ const ExitNetwork

+ const ExitSuccess

+ const ExitValidation

+ const MaxConfigBytesCeiling

+ const ModeDetectionRule

+ const SchemaVersion

+ const ZeroSpanID

+ const ZeroTraceID

+ func DryRunFromContext(ctx context.Context) bool

+ func ErrorExitCode(err error) int

+ func Execute(ctx context.Context, root *cobra.Command, opts ...ExecuteOption) int

+ func GRPCDial(ctx context.Context, target string, opts ...grpc.DialOption) (*grpc.ClientConn, error)

+ func HTTPClient() *http.Client

+ func IdempotencyKeyFromContext(ctx context.Context) (string, bool)

+ func NewEntityID() (string, error)

+ func NewIdempotencyKey() string

+ func NewSchemaCommand(root *cobra.Command, opts ...SchemaOption) *cobra.Command

+ func ParseConfig(ctx context.Context, r io.Reader, dst any, opts ...ParseConfigOption) error

+ func ParseConfigFile(ctx context.Context, path string, dst any, opts ...ParseConfigOption) error

+ func ResolveVersion(injected string) string

+ func SpanIDFromContext(ctx context.Context) string

+ func TraceIDFromContext(ctx context.Context) string

+ func WithDryRun(ctx context.Context, dryRun bool) context.Context

+ func WithIdempotencyKey(ctx context.Context, key string) context.Context

+ func WithMode(ctx context.Context, mode Mode) context.Context

+ func WriteError(w io.Writer, err error) error

+ func WriteJSON(w io.Writer, v any) error

+ func WriteJSONLine(w io.Writer, v any) error

+ type CommandSchema struct

+ Commands []CommandSchema

+ Example string

+ Flags []FlagSchema

+ Long string

+ Short string

+ Use string

+ type Envelope struct

+ Data T

+ Meta Metadata

+ func NewEnvelope[T any](ctx context.Context, data T) Envelope[T]

+ type Error struct

+ ActionableFix string

+ Context map[string]any

+ ErrorCode string

+ Message string

+ SchemaVersion string

+ Suggestions []string

+ Tool string

+ TraceID string

+ Version string

+ func NewError(ctx context.Context, code, message string, opts ...ErrorOption) *Error

+ func (e *Error) Error() string

+ func (e *Error) ExitCode() int

+ func (e *Error) Unwrap() error

+ type ErrorOption func(*Error)

+ func WithActionableFix(fix string) ErrorOption

+ func WithErrorCause(err error) ErrorOption

+ func WithErrorContext(fields map[string]any) ErrorOption

+ func WithErrorExitCode(code int) ErrorOption

+ func WithErrorTool(tool string) ErrorOption

+ func WithErrorVersion(version string) ErrorOption

+ func WithSuggestions(suggestions ...string) ErrorOption

+ type ErrorSchemaInfo struct

+ Optional []string

+ Required []string

+ SchemaVersion string

+ type ExecuteOption func(*executeConfig)

+ func WithEnv(env func(string) string) ExecuteOption

+ func WithStderr(w io.Writer) ExecuteOption

+ func WithStdin(r io.Reader) ExecuteOption

+ func WithStdout(w io.Writer) ExecuteOption

+ func WithStdoutIsTTY(isTTY bool) ExecuteOption

+ func WithTelemetryShutdownTimeout(timeout time.Duration) ExecuteOption

+ func WithVersion(version string) ExecuteOption

+ type FlagSchema struct

+ Default string

+ Name string

+ Required bool

+ Shorthand string

+ Type string

+ Usage string

+ type Labels struct

+ Application string

+ Environment string

+ Host string

+ Version string

+ type Logger interface

+ Debug func(ctx context.Context) *zerolog.Event

+ Error func(ctx context.Context) *zerolog.Event

+ Info func(ctx context.Context) *zerolog.Event

+ Warn func(ctx context.Context) *zerolog.Event

+ WithLabels func(labels Labels) Logger

+ Zerolog func() *zerolog.Logger

+ func NewLogger(ctx context.Context, opts ...LoggerOption) Logger

+ type LoggerOption func(*loggerConfig)

+ func WithLoggerLabels(labels Labels) LoggerOption

+ func WithLoggerLevel(level zerolog.Level) LoggerOption

+ func WithLoggerWriter(w io.Writer) LoggerOption

+ type MCPSchema struct

+ Tools []MCPTool

+ func BuildMCPSchema(root *cobra.Command) MCPSchema

+ type MCPTool struct

+ Description string

+ InputSchema map[string]any

+ Name string

+ type Metadata struct

+ DryRun bool

+ IdempotencyKey string

+ SpanID string

+ TraceID string

+ type Mode string

+ const ModeHuman

+ const ModeJSON

+ func ModeFromContext(ctx context.Context) (Mode, bool)

+ func ParseMode(value string) (Mode, error)

+ func ResolveMode(explicitFormat, agentMode string, stdoutIsTTY bool) (Mode, error)

+ func (m Mode) String() string

+ type ParseConfigOption func(*parseConfigOptions)

+ func WithMaxConfigBytes(maxBytes int64) ParseConfigOption

+ type Schema struct

+ Command CommandSchema

+ ErrorEnvelope ErrorSchemaInfo

+ ModeDetection string

+ SchemaVersion string

+ Tool string

+ Version string

+ func BuildSchema(root *cobra.Command, opts ...SchemaOption) Schema

+ type SchemaOption func(*schemaConfig)

+ func WithSchemaVersion(version string) SchemaOption

+ type Telemetry struct

+ TracerProvider *sdktrace.TracerProvider

+ func StartTelemetry(ctx context.Context, opts ...TelemetryOption) (context.Context, *Telemetry, error)

+ func (t *Telemetry) Shutdown(ctx context.Context) error

+ type TelemetryOption func(*telemetryConfig)

+ func WithTelemetryEnv(env func(string) string) TelemetryOption

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