claudecode

package module

Go to main page

Versions in this module

v0

v0.0.9

Jul 16, 2026

Changes in this version

+ const DefaultSkillRegistryPluginName

+ func CanonicalSkillName(name string) string

+ func SkillRegistryScopedName(pluginName, skillName string) string

v0.0.8

Jul 8, 2026

v0.0.7

Jun 30, 2026

v0.0.6

Jun 24, 2026

Changes in this version

+ const EffortHigh

+ const EffortLow

+ const EffortMax

+ const EffortMedium

+ const EffortXHigh

+ const SessionBlockTypeBashCodeExecutionToolResult

+ const SessionBlockTypeCodeExecutionToolResult

+ const SessionBlockTypeContainerUpload

+ const SessionBlockTypeImage

+ const SessionBlockTypeRedactedThinking

+ const SessionBlockTypeServerToolUse

+ const SessionBlockTypeText

+ const SessionBlockTypeTextEditorCodeExecToolResult

+ const SessionBlockTypeThinking

+ const SessionBlockTypeToolResult

+ const SessionBlockTypeToolSearchToolResult

+ const SessionBlockTypeToolUse

+ const SessionBlockTypeWebFetchToolResult

+ const SessionBlockTypeWebSearchToolResult

+ const SessionContentTypeBlocks

+ const SessionContentTypeString

+ var WithIncludeWorktrees = session.WithIncludeWorktrees

+ var WithSessionDirectory = session.WithSessionDirectory

+ var WithSessionLimit = session.WithSessionLimit

+ var WithSessionOffset = session.WithSessionOffset

+ type EffortLevel = shared.EffortLevel

type Option

+ func WithEffort(effort EffortLevel) Option

+ type SDKSessionInfo = session.SDKSessionInfo

+ func GetSessionInfo(sessionID string, opts ...SessionOption) (*SDKSessionInfo, error)

+ func ListSessions(opts ...SessionOption) ([]SDKSessionInfo, error)

+ type SessionContentBlock = session.ContentBlock

+ type SessionContentType = session.ContentType

+ type SessionMessage = session.Message

+ func GetSessionMessages(sessionID string, opts ...SessionOption) ([]SessionMessage, error)

+ type SessionMessageContent = session.MessageContent

+ type SessionOption = session.Option

v0.0.5

Jun 3, 2026

Changes in this version

type Client

+ GetSlashCommands func(ctx context.Context) ([]SlashCommand, error)

type ClientImpl

+ func (c *ClientImpl) GetSlashCommands(ctx context.Context) ([]SlashCommand, error)

type Option

+ func WithSkillRegistry(root string, names ...string) Option

+ func WithSkillRegistryAll(root string) Option

+ type SkillRegistryConfig = shared.SkillRegistryConfig

+ type SlashCommand = control.SlashCommand

+ func DiscoverSlashCommands(ctx context.Context, opts ...Option) ([]SlashCommand, error)

type Transport

+ GetSlashCommands func(ctx context.Context) ([]SlashCommand, error)

v0.0.4

May 20, 2026

Changes in this version

+ const HookEventNotification

+ const HookEventPermissionRequest

+ const HookEventPostToolUseFailure

+ const HookEventSubagentStart

+ const MessageTypeRateLimitEvent

+ const RateLimitStatusAllowed

+ const SkillsAll

+ const StopReasonEndTurn

+ const StopReasonMaxTokens

+ const StopReasonStopSequence

+ const StopReasonToolUse

type McpTool

+ func (t *McpTool) Annotations() *ToolAnnotations

+ type NotificationHookInput = control.NotificationHookInput

+ type NotificationHookSpecificOutput = control.NotificationHookSpecificOutput

type Option

+ func WithSkillImplementation(name string, handler func(context.Context, string) (string, error)) Option

+ func WithSkillImplementations(skills map[string]func(context.Context, string) (string, error)) Option

+ func WithSkillsAll() Option

+ func WithSkillsDisabled() Option

+ func WithSkillsList(names ...string) Option

+ type PermissionRequestHookInput = control.PermissionRequestHookInput

+ type PermissionRequestHookSpecificOutput = control.PermissionRequestHookSpecificOutput

+ type PostToolUseFailureHookInput = control.PostToolUseFailureHookInput

+ type PostToolUseFailureHookSpecificOutput = control.PostToolUseFailureHookSpecificOutput

+ type RateLimitEventMessage = shared.RateLimitEventMessage

+ type RateLimitInfo = shared.RateLimitInfo

+ type RawMessage = shared.RawMessage

+ type SubagentStartHookInput = control.SubagentStartHookInput

+ type SubagentStartHookSpecificOutput = control.SubagentStartHookSpecificOutput

+ type ToolAnnotations = shared.ToolAnnotations

+ type ToolOption func(*McpTool)

+ func WithToolAnnotations(ann *ToolAnnotations) ToolOption

+ type Usage = shared.Usage

v0.0.3

May 11, 2026

v0.0.2

May 11, 2026

v0.0.1

May 11, 2026

Changes in this version

+ const AgentModelHaiku

+ const AgentModelInherit

+ const AgentModelOpus

+ const AgentModelSonnet

+ const AssistantMessageErrorAuthFailed

+ const AssistantMessageErrorBilling

+ const AssistantMessageErrorInvalidRequest

+ const AssistantMessageErrorRateLimit

+ const AssistantMessageErrorServer

+ const AssistantMessageErrorUnknown

+ const ContentBlockTypeText

+ const ContentBlockTypeThinking

+ const ContentBlockTypeToolResult

+ const ContentBlockTypeToolUse

+ const HookEventPostToolUse

+ const HookEventPreCompact

+ const HookEventPreToolUse

+ const HookEventStop

+ const HookEventSubagentStop

+ const HookEventUserPromptSubmit

+ const McpServerConfigTypeClaudeAI

+ const McpServerConfigTypeHTTP

+ const McpServerConfigTypeSDK

+ const McpServerConfigTypeSSE

+ const McpServerConfigTypeStdio

+ const McpServerConnectionStatusConnected

+ const McpServerConnectionStatusDisabled

+ const McpServerConnectionStatusFailed

+ const McpServerConnectionStatusNeedsAuth

+ const McpServerConnectionStatusPending

+ const McpServerTypeHTTP

+ const McpServerTypeSSE

+ const McpServerTypeSdk

+ const McpServerTypeStdio

+ const MessageTypeAssistant

+ const MessageTypeControlRequest

+ const MessageTypeControlResponse

+ const MessageTypeResult

+ const MessageTypeStreamEvent

+ const MessageTypeSystem

+ const MessageTypeUser

+ const PermissionModeAcceptEdits

+ const PermissionModeBypassPermissions

+ const PermissionModeDefault

+ const PermissionModePlan

+ const PermissionUpdateTypeAddDirectories

+ const PermissionUpdateTypeAddRules

+ const PermissionUpdateTypeRemoveDirectories

+ const PermissionUpdateTypeRemoveRules

+ const PermissionUpdateTypeReplaceRules

+ const PermissionUpdateTypeSetMode

+ const ResponseSubtypeError

+ const ResponseSubtypeSuccess

+ const SdkBetaContext1M

+ const SdkPluginTypeLocal

+ const SettingSourceLocal

+ const SettingSourceProject

+ const SettingSourceUser

+ const StreamEventTypeContentBlockDelta

+ const StreamEventTypeContentBlockStart

+ const StreamEventTypeContentBlockStop

+ const StreamEventTypeMessageDelta

+ const StreamEventTypeMessageStart

+ const StreamEventTypeMessageStop

+ const SubtypeCanUseTool

+ const SubtypeGetMcpStatus

+ const SubtypeHookCallback

+ const SubtypeInitialize

+ const SubtypeInterrupt

+ const SubtypeMcpMessage

+ const SubtypeRewindFiles

+ const SubtypeSetModel

+ const SubtypeSetPermissionMode

+ const Version

+ var AsCLINotFoundError = shared.AsCLINotFoundError

+ var AsConnectionError = shared.AsConnectionError

+ var AsJSONDecodeError = shared.AsJSONDecodeError

+ var AsMessageParseError = shared.AsMessageParseError

+ var AsProcessError = shared.AsProcessError

+ var ErrNoMoreMessages = errors.New("no more messages")

+ var IsCLINotFoundError = shared.IsCLINotFoundError

+ var IsConnectionError = shared.IsConnectionError

+ var IsJSONDecodeError = shared.IsJSONDecodeError

+ var IsMessageParseError = shared.IsMessageParseError

+ var IsProcessError = shared.IsProcessError

+ var NewCLINotFoundError = shared.NewCLINotFoundError

+ var NewConnectionError = shared.NewConnectionError

+ var NewJSONDecodeError = shared.NewJSONDecodeError

+ var NewMessageParseError = shared.NewMessageParseError

+ var NewPermissionResultAllow = control.NewPermissionResultAllow

+ var NewPermissionResultDeny = control.NewPermissionResultDeny

+ var NewProcessError = shared.NewProcessError

+ func RegisterSkill(name string, handler func(context.Context, string) (string, error))

+ func RegisterSkills(skills map[string]func(context.Context, string) (string, error))

+ func WithClient(ctx context.Context, fn func(Client) error, opts ...Option) error

+ func WithClientTransport(ctx context.Context, transport Transport, fn func(Client) error, ...) error

+ type AgentDefinition = shared.AgentDefinition

+ type AgentModel = shared.AgentModel

+ type AssistantMessage = shared.AssistantMessage

+ type AssistantMessageError = shared.AssistantMessageError

+ type AsyncHookJSONOutput = control.AsyncHookJSONOutput

+ type BaseError = shared.BaseError

+ type BaseHookInput = control.BaseHookInput

+ type CLINotFoundError = shared.CLINotFoundError

+ type CanUseToolCallback = control.CanUseToolCallback

+ type Client interface

+ Connect func(ctx context.Context, prompt ...StreamMessage) error

+ Disconnect func() error

+ GetMcpStatus func(ctx context.Context) (*McpStatusResponse, error)

+ GetServerInfo func(ctx context.Context) (map[string]interface{}, error)

+ GetStreamIssues func() []StreamIssue

+ GetStreamStats func() StreamStats

+ Interrupt func(ctx context.Context) error

+ Query func(ctx context.Context, prompt string) error

+ QueryStream func(ctx context.Context, messages <-chan StreamMessage) error

+ QueryWithSession func(ctx context.Context, prompt string, sessionID string) error

+ ReceiveMessages func(ctx context.Context) <-chan Message

+ ReceiveResponse func(ctx context.Context) MessageIterator

+ RewindFiles func(ctx context.Context, messageUUID string) error

+ SetModel func(ctx context.Context, model *string) error

+ SetPermissionMode func(ctx context.Context, mode PermissionMode) error

+ func NewClient(opts ...Option) Client

+ func NewClientWithTransport(transport Transport, opts ...Option) Client

+ type ClientImpl struct

+ func (c *ClientImpl) Connect(ctx context.Context, _ ...StreamMessage) error

+ func (c *ClientImpl) Disconnect() error

+ func (c *ClientImpl) GetMcpStatus(ctx context.Context) (*McpStatusResponse, error)

+ func (c *ClientImpl) GetServerInfo(_ context.Context) (map[string]interface{}, error)

+ func (c *ClientImpl) GetStreamIssues() []StreamIssue

+ func (c *ClientImpl) GetStreamStats() StreamStats

+ func (c *ClientImpl) Interrupt(ctx context.Context) error

+ func (c *ClientImpl) Query(ctx context.Context, prompt string) error

+ func (c *ClientImpl) QueryStream(ctx context.Context, messages <-chan StreamMessage) error

+ func (c *ClientImpl) QueryWithSession(ctx context.Context, prompt string, sessionID string) error

+ func (c *ClientImpl) ReceiveMessages(_ context.Context) <-chan Message

+ func (c *ClientImpl) ReceiveResponse(_ context.Context) MessageIterator

+ func (c *ClientImpl) RewindFiles(ctx context.Context, messageUUID string) error

+ func (c *ClientImpl) SetModel(ctx context.Context, model *string) error

+ func (c *ClientImpl) SetPermissionMode(ctx context.Context, mode PermissionMode) error

+ type ConnectionError = shared.ConnectionError

+ type ContentBlock = shared.ContentBlock

+ type ControlProtocol = control.Protocol

+ type ControlResponse = control.Response

+ type GetMcpStatusRequest = control.GetMcpStatusRequest

+ type HookCallback = control.HookCallback

+ type HookContext = control.HookContext

+ type HookEvent = control.HookEvent

+ type HookJSONOutput = control.HookJSONOutput

+ type HookMatcher = control.HookMatcher

+ type InitializeRequest = control.InitializeRequest

+ type InitializeResponse = control.InitializeResponse

+ type InterruptRequest = control.InterruptRequest

+ type JSONDecodeError = shared.JSONDecodeError

+ type McpContent = shared.McpContent

+ type McpHTTPServerConfig = shared.McpHTTPServerConfig

+ type McpSSEServerConfig = shared.McpSSEServerConfig

+ type McpSdkServerConfig = shared.McpSdkServerConfig

+ func CreateSDKMcpServer(name, version string, tools ...*McpTool) *McpSdkServerConfig

+ type McpServerConfig = shared.McpServerConfig

+ type McpServerConnectionStatus = control.McpServerConnectionStatus

+ type McpServerInfo = control.McpServerInfo

+ type McpServerStatus = control.McpServerStatus

+ type McpServerStatusConfig = control.McpServerStatusConfig

+ type McpServerType = shared.McpServerType

+ type McpStatusResponse = control.McpStatusResponse

+ type McpStdioServerConfig = shared.McpStdioServerConfig

+ type McpTool struct

+ func NewTool(name, description string, inputSchema map[string]any, handler McpToolHandler) *McpTool

+ func (t *McpTool) Call(ctx context.Context, args map[string]any) (*McpToolResult, error)

+ func (t *McpTool) Description() string

+ func (t *McpTool) InputSchema() map[string]any

+ func (t *McpTool) Name() string

+ type McpToolAnnotations = control.McpToolAnnotations

+ type McpToolDefinition = shared.McpToolDefinition

+ type McpToolHandler func(ctx context.Context, args map[string]any) (*McpToolResult, error)

+ type McpToolInfo = control.McpToolInfo

+ type McpToolResult = shared.McpToolResult

+ type Message = shared.Message

+ type MessageIterator = shared.MessageIterator

+ func Query(ctx context.Context, prompt string, opts ...Option) (MessageIterator, error)

+ func QueryWithTransport(ctx context.Context, prompt string, transport Transport, opts ...Option) (MessageIterator, error)

+ type MessageParseError = shared.MessageParseError

+ type Option func(*Options)

+ func WithAddDirs(dirs ...string) Option

+ func WithAgent(name string, agent AgentDefinition) Option

+ func WithAgents(agents map[string]AgentDefinition) Option

+ func WithAllowedTools(tools ...string) Option

+ func WithAppendSystemPrompt(prompt string) Option

+ func WithAutoAllowBashIfSandboxed(autoAllow bool) Option

+ func WithBetas(betas ...SdkBeta) Option

+ func WithCLIPath(path string) Option

+ func WithCanUseTool(callback CanUseToolCallback) Option

+ func WithClaudeCodeTools() Option

+ func WithContinueConversation(continueConversation bool) Option

+ func WithCwd(cwd string) Option

+ func WithDebugDisabled() Option

+ func WithDebugStderr() Option

+ func WithDebugWriter(w io.Writer) Option

+ func WithDisallowedTools(tools ...string) Option

+ func WithEnableFileCheckpointing(enable bool) Option

+ func WithEnv(env map[string]string) Option

+ func WithEnvVar(key, value string) Option

+ func WithExtraArgs(args map[string]*string) Option

+ func WithFallbackModel(model string) Option

+ func WithFileCheckpointing() Option

+ func WithForkSession(fork bool) Option

+ func WithHook(event HookEvent, matcher string, callback HookCallback) Option

+ func WithHooks(hooks map[HookEvent][]HookMatcher) Option

+ func WithIncludePartialMessages(include bool) Option

+ func WithJSONSchema(schema map[string]any) Option

+ func WithLocalPlugin(path string) Option

+ func WithMaxBudgetUSD(budget float64) Option

+ func WithMaxBufferSize(size int) Option

+ func WithMaxThinkingTokens(tokens int) Option

+ func WithMaxTurns(turns int) Option

+ func WithMcpServers(servers map[string]McpServerConfig) Option

+ func WithModel(model string) Option

+ func WithOutputFormat(format *OutputFormat) Option

+ func WithPartialStreaming() Option

+ func WithPermissionMode(mode PermissionMode) Option

+ func WithPermissionPromptToolName(toolName string) Option

+ func WithPlugin(plugin SdkPluginConfig) Option

+ func WithPlugins(plugins []SdkPluginConfig) Option

+ func WithPostToolUseHook(matcher string, callback HookCallback) Option

+ func WithPreToolUseHook(matcher string, callback HookCallback) Option

+ func WithResume(sessionID string) Option

+ func WithSandbox(sandbox *SandboxSettings) Option

+ func WithSandboxEnabled(enabled bool) Option

+ func WithSandboxExcludedCommands(commands ...string) Option

+ func WithSandboxNetwork(network *SandboxNetworkConfig) Option

+ func WithSdkMcpServer(name string, server *McpSdkServerConfig) Option

+ func WithSettingSources(sources ...SettingSource) Option

+ func WithSettings(settings string) Option

+ func WithSkill(name string, handler func(context.Context, string) (string, error)) Option

+ func WithSkills(skills map[string]func(context.Context, string) (string, error)) Option

+ func WithStderrCallback(callback func(string)) Option

+ func WithSystemPrompt(prompt string) Option

+ func WithTools(tools ...string) Option

+ func WithToolsPreset(preset string) Option

+ func WithTransport(_ Transport) Option

+ func WithUser(user string) Option

+ type Options = shared.Options

+ func NewOptions(opts ...Option) *Options

+ type OutputFormat = shared.OutputFormat

+ func OutputFormatJSONSchema(schema map[string]any) *OutputFormat

+ type PermissionMode = shared.PermissionMode

+ type PermissionResult = control.PermissionResult

+ type PermissionResultAllow = control.PermissionResultAllow

+ type PermissionResultDeny = control.PermissionResultDeny

+ type PermissionRuleValue = control.PermissionRuleValue

+ type PermissionUpdate = control.PermissionUpdate

+ type PermissionUpdateType = control.PermissionUpdateType

+ type PostToolUseHookInput = control.PostToolUseHookInput

+ type PostToolUseHookSpecificOutput = control.PostToolUseHookSpecificOutput

+ type PreCompactHookInput = control.PreCompactHookInput

+ type PreToolUseHookInput = control.PreToolUseHookInput

+ type PreToolUseHookSpecificOutput = control.PreToolUseHookSpecificOutput

+ type ProcessError = shared.ProcessError

+ type RawControlMessage = shared.RawControlMessage

+ type ResultMessage = shared.ResultMessage

+ type SDKControlRequest = control.SDKControlRequest

+ type SDKControlResponse = control.SDKControlResponse

+ type SDKError = shared.SDKError

+ type SandboxIgnoreViolations = shared.SandboxIgnoreViolations

+ type SandboxNetworkConfig = shared.SandboxNetworkConfig

+ type SandboxSettings = shared.SandboxSettings

+ type SdkBeta = shared.SdkBeta

+ type SdkMcpServer struct

+ func (s *SdkMcpServer) CallTool(ctx context.Context, name string, args map[string]any) (*McpToolResult, error)

+ func (s *SdkMcpServer) ListTools(_ context.Context) ([]McpToolDefinition, error)

+ func (s *SdkMcpServer) Name() string

+ func (s *SdkMcpServer) Version() string

+ type SdkPluginConfig = shared.SdkPluginConfig

+ type SdkPluginType = shared.SdkPluginType

+ type SetModelRequest = control.SetModelRequest

+ type SetPermissionModeRequest = control.SetPermissionModeRequest

+ type SettingSource = shared.SettingSource

+ type StopHookInput = control.StopHookInput

+ type StreamEvent = shared.StreamEvent

+ type StreamIssue = shared.StreamIssue

+ type StreamMessage = shared.StreamMessage

+ type StreamStats = shared.StreamStats

+ type StreamValidator = shared.StreamValidator

+ type SubagentStopHookInput = control.SubagentStopHookInput

+ type SystemMessage = shared.SystemMessage

+ type TextBlock = shared.TextBlock

+ type ThinkingBlock = shared.ThinkingBlock

+ type ToolPermissionContext = control.ToolPermissionContext

+ type ToolResultBlock = shared.ToolResultBlock

+ type ToolUseBlock = shared.ToolUseBlock

+ type ToolsPreset = shared.ToolsPreset

+ type Transport interface

+ Close func() error

+ Connect func(ctx context.Context) error

+ GetMcpStatus func(ctx context.Context) (*McpStatusResponse, error)

+ GetValidator func() *StreamValidator

+ Interrupt func(ctx context.Context) error

+ ReceiveMessages func(ctx context.Context) (<-chan Message, <-chan error)

+ RewindFiles func(ctx context.Context, userMessageID string) error

+ SendMessage func(ctx context.Context, message StreamMessage) error

+ SetModel func(ctx context.Context, model *string) error

+ SetPermissionMode func(ctx context.Context, mode PermissionMode) error

+ type UserMessage = shared.UserMessage

+ type UserPromptSubmitHookInput = control.UserPromptSubmitHookInput

+ type UserPromptSubmitHookSpecificOutput = control.UserPromptSubmitHookSpecificOutput

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