Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

opencode

package

Go to main page

Versions in this module

v1

v1.6.1

Feb 8, 2026

v1.6.0

Feb 7, 2026

v1.5.0

Feb 6, 2026

v1.4.7

Feb 6, 2026

v1.4.6

Feb 5, 2026

v1.4.5

Feb 5, 2026

v1.4.4

Feb 4, 2026

v1.4.3

Jan 26, 2026

v1.4.2

Jan 26, 2026

v1.4.1

Jan 24, 2026

v1.4.0

Jan 24, 2026

v1.3.1

Jan 24, 2026

v1.3.0

Jan 24, 2026

v1.2.0

Jan 11, 2026

Changes in this version

+ var ErrContextTooLong = errors.New("context exceeds maximum length")

+ var ErrInvalidRequest = errors.New("invalid request")

+ var ErrRateLimited = errors.New("rate limited")

+ var ErrTimeout = errors.New("request timed out")

+ var ErrUnavailable = errors.New("LLM service unavailable")

+ type Agent string

+ const AgentBuild

+ const AgentPlan

+ type CLIResponse struct

+ Duration int

+ Error string

+ IsError bool

+ Model string

+ Result string

+ ToolCalls []CLIToolCall

+ Usage *CLIUsage

+ type CLIToolCall struct

+ Arguments json.RawMessage

+ ID string

+ Name string

+ type CLIUsage struct

+ InputTokens int

+ OutputTokens int

+ type Capabilities struct

+ ContextFile string

+ Images bool

+ MCP bool

+ NativeTools []string

+ Sessions bool

+ Streaming bool

+ Tools bool

+ func (c Capabilities) HasTool(name string) bool

+ type CompletionRequest struct

+ MaxTokens int

+ Messages []Message

+ Model string

+ Options map[string]any

+ SystemPrompt string

+ Temperature float64

+ Tools []Tool

+ type CompletionResponse struct

+ Content string

+ Duration time.Duration

+ FinishReason string

+ Model string

+ ToolCalls []ToolCall

+ Usage TokenUsage

+ type Config struct

+ Agent Agent

+ AllowedTools []string

+ Debug bool

+ DisallowedTools []string

+ Env map[string]string

+ MaxTurns int

+ OpenCodePath string

+ OutputFormat OutputFormat

+ Quiet bool

+ SystemPrompt string

+ Timeout time.Duration

+ WorkDir string

+ func DefaultConfig() Config

+ func FromEnv() Config

+ func (c *Config) LoadFromEnv()

+ func (c *Config) ToOptions() []OpenCodeOption

+ func (c *Config) Validate() error

+ type Error struct

+ Err error

+ Op string

+ Retryable bool

+ func NewError(op string, err error, retryable bool) *Error

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type MCPServerConfig struct

+ Args []string

+ Command string

+ Env map[string]string

+ Headers []string

+ Type string

+ URL string

+ type Message struct

+ Content string

+ Name string

+ Role Role

+ type OpenCodeCLI struct

+ func NewFromConfig(cfg Config, opts ...OpenCodeOption) *OpenCodeCLI

+ func NewFromEnv(opts ...OpenCodeOption) *OpenCodeCLI

+ func NewOpenCodeCLI(opts ...OpenCodeOption) *OpenCodeCLI

+ func (c *OpenCodeCLI) Capabilities() Capabilities

+ func (c *OpenCodeCLI) Close() error

+ func (c *OpenCodeCLI) Complete(ctx context.Context, req CompletionRequest) (*CompletionResponse, error)

+ func (c *OpenCodeCLI) Provider() string

+ func (c *OpenCodeCLI) Stream(ctx context.Context, req CompletionRequest) (<-chan StreamChunk, error)

+ type OpenCodeOption func(*OpenCodeCLI)

+ func WithAgent(agent Agent) OpenCodeOption

+ func WithAllowedTools(tools []string) OpenCodeOption

+ func WithDebug(debug bool) OpenCodeOption

+ func WithDisallowedTools(tools []string) OpenCodeOption

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

+ func WithEnvVar(key, value string) OpenCodeOption

+ func WithMCPConfig(path string) OpenCodeOption

+ func WithMCPServers(servers map[string]MCPServerConfig) OpenCodeOption

+ func WithMaxTurns(n int) OpenCodeOption

+ func WithOpenCodePath(path string) OpenCodeOption

+ func WithOutputFormat(format OutputFormat) OpenCodeOption

+ func WithQuiet(quiet bool) OpenCodeOption

+ func WithSystemPrompt(prompt string) OpenCodeOption

+ func WithTimeout(d time.Duration) OpenCodeOption

+ func WithWorkdir(dir string) OpenCodeOption

+ type OutputFormat string

+ const OutputFormatJSON

+ const OutputFormatText

+ type Role string

+ const RoleAssistant

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ type StreamChunk struct

+ Content string

+ Done bool

+ Error error

+ ToolCalls []ToolCall

+ Usage *TokenUsage

+ type TokenUsage struct

+ InputTokens int

+ OutputTokens int

+ TotalTokens int

+ func (u *TokenUsage) Add(other TokenUsage)

+ type Tool struct

+ Description string

+ Name string

+ Parameters json.RawMessage

+ type ToolCall struct

+ Arguments json.RawMessage

+ ID string

+ Name string