Versions in this module Expand all Collapse all v1 v1.0.94 Sep 7, 2026 v1.0.93 Sep 1, 2026 v1.0.92 Aug 28, 2026 v1.0.91 Aug 27, 2026 v1.0.90 Aug 25, 2026 Changes in this version + const AliasCanonicalWins + const AliasErrorIfBoth + const AliasIndependent + const AliasNormalize + const AliasTrimmedEqualOrError + const IdentityBot + const IdentityUser + const PresenceExplicit + const PresenceNonZero + const RelationAtLeastOne + const RelationCoOccur + const RelationConflicts + const RelationExactlyOne + const RelationRequires + const RiskHighRiskWrite + const RiskRead + const RiskWrite + const StageAfterPrepare + const StageSourcePreRun + func CallJSON[T any](ctx context.Context, command CommandContext, request Request) (T, error) + func CollectAllPages[T any](ctx context.Context, command CommandContext, request Request) ([]T, error) + func InternalErrorf(format string, args ...any) *errs.InternalError + func InvalidResponseErrorf(format string, args ...any) *errs.InternalError + func PaginationInterruptedError(cause error) *errs.NetworkError + func PaginationLimitError(pages int, nextToken string) *errs.InternalError + func PathSegment(s string) string + func PreflightScopes(command CommandContext, scopes ...string) error + func ValidateHostResult(definition HostDefinition, result HostResult) error + func ValidateRequestView(request RequestView) error + func ValidationErrorf(format string, args ...any) *errs.ValidationError + type AliasConflictPolicy string + type ArrayShape struct + Items ValueShape + MaxItems *int + MinItems *int + type Artifact struct + ContentType string + Location string + Name string + Size int64 + func Download(ctx context.Context, command CommandContext, request Request, ...) (Artifact, error) + func DownloadURL(ctx context.Context, command CommandContext, rawURL string, target FileTarget, ...) (Artifact, error) + type AuthorizationDefinition struct + Identities map[Identity]IdentityAuthorization + IdentityOrder []Identity + type BooleanShape struct + Enum []bool + type CLIEncoding string + const EncodingCommaOrRepeated + const EncodingJSON + const EncodingRepeated + type CLIInput struct + Aliases []FlagAlias + Deprecated string + Encoding CLIEncoding + Hidden bool + ValueSources []ValueSource + type Command struct + func Define[Args any, Data any](definition Definition[Args, Data]) Command + type CommandContext struct + func NewCommandContext(options ContextOptions) CommandContext + func (c CommandContext) Identity() Identity + type CommandMetadata struct + Authorization AuthorizationDefinition + Command string + Description string + Hidden bool + Risk Risk + Service DomainName + type ConditionalScope struct + Params []string + Requirement ScopeRequirement + Scopes []string + When string + type ConstShape struct + Value JSONValue + type ContextOptions struct + CallJSON func(context.Context, Request) (map[string]any, error) + CollectPages func(context.Context, Request, bool) ([]map[string]any, HostPagination, error) + Download func(context.Context, Request, FileTarget, DownloadOptions) (Artifact, error) + DownloadURL func(context.Context, string, FileTarget, DownloadOptions) (Artifact, error) + DryRun bool + Identity Identity + InputStage bool + PreflightScopes func(...string) error + type DataDefinition struct + Overrides []DataField + Shape ValueShape + type DataField struct + Description string + Path string + Shape ValueShape + type Definition struct + Hooks Hooks[Args, Data] + Input InputDefinition + Metadata CommandMetadata + Output OutputDefinition + type Domain struct + func ExtendDomain(name DomainName) Domain + type DomainName string + const DomainApplication + const DomainApproval + const DomainApps + const DomainAttendance + const DomainBase + const DomainCalendar + const DomainContact + const DomainDocs + const DomainDrive + const DomainEvent + const DomainIm + const DomainMail + const DomainMarkdown + const DomainMindnotes + const DomainMinutes + const DomainNote + const DomainOkr + const DomainSheets + const DomainSlides + const DomainTask + const DomainVc + const DomainWhiteboard + const DomainWiki + type DownloadOptions struct + Representation download.Representation + Transfer download.Options + type DryRun struct + func NewDryRun(requests ...Request) *DryRun + func (d *DryRun) Add(request Request) *DryRun + func (d *DryRun) Body(body any) *DryRun + func (d *DryRun) DELETE(apiPath string) *DryRun + func (d *DryRun) Desc(description string) *DryRun + func (d *DryRun) File(intent FileIntent) *DryRun + func (d *DryRun) GET(apiPath string) *DryRun + func (d *DryRun) PATCH(apiPath string) *DryRun + func (d *DryRun) POST(apiPath string) *DryRun + func (d *DryRun) PUT(apiPath string) *DryRun + func (d *DryRun) Params(params map[string]any) *DryRun + func (d *DryRun) Set(name string, value any) *DryRun + type DryRunView struct + Description string + Files []FileIntent + Requests []RequestView + func InspectDryRun(dryRun *DryRun) DryRunView + type Failure struct + Code int + Hint string + LogID string + Message string + Retryable bool + Subtype string + Type string + func SnapshotFailure(err error) Failure + type FileIntent struct + Content string + IfExists IfExistsPolicy + Name string + type FileTarget struct + IfExists IfExistsPolicy + Name string + func (t FileTarget) Intent(content string) FileIntent + type FlagAlias struct + Conflict AliasConflictPolicy + Deprecated bool + Hidden bool + Mode FlagAliasMode + Name string + type FlagAliasMode string + type Hooks struct + DryRun func(context.Context, CommandContext, *Args) *DryRun + Execute func(context.Context, CommandContext, *Args) (Result[Data], error) + Normalize func(context.Context, CommandContext, *Args) error + PrettyRenderer Renderer[Data] + Validate func(context.Context, CommandContext, *Args) error + type HostDefinition struct + ArgsType reflect.Type + DataType reflect.Type + Hooks HostHooks + Input InputDefinition + Metadata CommandMetadata + NewArgs func() any + Output OutputDefinition + PageOutput bool + func InspectCommand(command Command) HostDefinition + type HostDomain struct + Name string + func InspectDomain(domain Domain) HostDomain + type HostHooks struct + DryRun func(context.Context, CommandContext, any) *DryRun + Execute func(context.Context, CommandContext, any) (HostResult, error) + Normalize func(context.Context, CommandContext, any) error + Renderers map[string]func(io.Writer, any) error + Validate func(context.Context, CommandContext, any) error + type HostPagination struct + Complete bool + Items int + NextToken string + Pages int + type HostResult struct + Data any + Outcome string + Pagination *HostPagination + type Identity string + type IdentityAuthorization struct + ConditionalScopes []ConditionalScope + RequiredScopes []string + type IfExistsPolicy string + const IfExistsFail + const IfExistsOverwrite + type InputDefault struct + Set bool + Value JSONValue + type InputDefinition struct + Fields []InputField + Relations []Relation + type InputField struct + CLI CLIInput + Default InputDefault + Description string + Name string + Shape ValueShape + type IntegerShape struct + Enum []int64 + Maximum *int64 + Minimum *int64 + type JSONValue = any + type NullShape struct + type NumberShape struct + Enum []float64 + Maximum *float64 + Minimum *float64 + type ObjectShape struct + AdditionalProperties bool + AdditionalPropertiesShape ValueShape + Fields []ValueField + type OneOfShape struct + Variants []ValueShape + type OutputDefinition struct + Data DataDefinition + DisableHTMLEscaping bool + Meta ResultMetaDefinition + Mode OutputMode + type OutputMode string + const OutputFixedJSON + const OutputGeneric + type Page struct + Items []T + func CollectPages[T any](ctx context.Context, command CommandContext, request Request) (Page[T], error) + func (p Page[T]) Complete() bool + func (p Page[T]) NextToken() string + func (p Page[T]) Pages() int + type PaginationOptions struct + All bool + Delay time.Duration + MaxPages int + type PresenceMode string + type Provided struct + Set bool + Value T + type Relation struct + Kind RelationKind + Params []string + Presence PresenceMode + Stage RelationStage + type RelationKind string + type RelationStage string + type Renderer func(io.Writer, Data) error + type Request struct + func DELETE(apiPath string) Request + func GET(apiPath string) Request + func PATCH(apiPath string) Request + func POST(apiPath string) Request + func PUT(apiPath string) Request + func (r Request) Body(body any) Request + func (r Request) Desc(description string) Request + func (r Request) Params(params map[string]any) Request + func (r Request) Set(name string, value any) Request + type RequestView struct + Body any + Description string + Method string + Path string + Query map[string]any + func InspectRequest(request Request) RequestView + type Result struct + func Success[Data any](data Data) Result[Data] + type ResultMetaDefinition struct + Pagination bool + type Risk string + type ScopeRequirement string + const ScopeBestEffort + const ScopeRequired + type Set struct + Commands []Command + Domain Domain + func CloneSets(sets []Set) []Set + type StringShape struct + Enum []string + Format string + MaxLength *int + MinLength *int + type ValueField struct + Description string + Name string + Required bool + Shape ValueShape + type ValueShape interface + type ValueSource string + const SourceFile + const SourceFlag + const SourceStdin
Go to main page