config

package

v0.0.55 Latest Latest Go to latest Published: Jun 27, 2025 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/opencode-ai/opencode

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config manages application configuration from various sources.

Constants ¶

View Source

const (
	// InitFlagFilename is the name of the file that indicates whether the project has been initialized
	InitFlagFilename = "init"
)

View Source

const (
	MaxTokensFallbackDefault = 4096
)

Application constants

Variables ¶

This section is empty.

Functions ¶

func LoadGitHubToken ¶ added in v0.0.54

func LoadGitHubToken() (string, error)

Tries to load Github token from all possible locations

func MarkProjectInitialized ¶

func MarkProjectInitialized() error

MarkProjectInitialized marks the current project as initialized

func ShouldShowInitDialog ¶

func ShouldShowInitDialog() (bool, error)

ShouldShowInitDialog checks if the initialization dialog should be shown for the current directory

func UpdateAgentModel ¶ added in v0.0.35

func UpdateAgentModel(agentName AgentName, modelID models.ModelID) error

func UpdateTheme ¶ added in v0.0.37

func UpdateTheme(themeName string) error

UpdateTheme updates the theme in the configuration and writes it to the config file.

func Validate ¶

func Validate() error

Validate checks if the configuration is valid and applies defaults where needed.

func WorkingDirectory ¶

func WorkingDirectory() string

WorkingDirectory returns the current working directory from the configuration.

Types ¶

type Agent ¶

type Agent struct {
	Model           models.ModelID `json:"model"`
	MaxTokens       int64          `json:"maxTokens"`
	ReasoningEffort string         `json:"reasoningEffort"` // For openai models low,medium,heigh
}

Agent defines configuration for different LLM models and their token limits.

type AgentName ¶

type AgentName string

const (
	AgentCoder      AgentName = "coder"
	AgentSummarizer AgentName = "summarizer"
	AgentTask       AgentName = "task"
	AgentTitle      AgentName = "title"
)

type Config ¶

type Config struct {
	Data         Data                              `json:"data"`
	WorkingDir   string                            `json:"wd,omitempty"`
	MCPServers   map[string]MCPServer              `json:"mcpServers,omitempty"`
	Providers    map[models.ModelProvider]Provider `json:"providers,omitempty"`
	LSP          map[string]LSPConfig              `json:"lsp,omitempty"`
	Agents       map[AgentName]Agent               `json:"agents,omitempty"`
	Debug        bool                              `json:"debug,omitempty"`
	DebugLSP     bool                              `json:"debugLSP,omitempty"`
	ContextPaths []string                          `json:"contextPaths,omitempty"`
	TUI          TUIConfig                         `json:"tui"`
	Shell        ShellConfig                       `json:"shell,omitempty"`
	AutoCompact  bool                              `json:"autoCompact,omitempty"`
}

Config is the main configuration structure for the application.

func Get ¶

func Get() *Config

Get returns the current configuration. It's safe to call this function multiple times.

func Load ¶

func Load(workingDir string, debug bool) (*Config, error)

Load initializes the configuration from environment variables and config files. If debug is true, debug mode is enabled and log level is set to debug. It returns an error if configuration loading fails.

type Data ¶

type Data struct {
	Directory string `json:"directory,omitempty"`
}

Data defines storage configuration.

type LSPConfig ¶

type LSPConfig struct {
	Disabled bool     `json:"enabled"`
	Command  string   `json:"command"`
	Args     []string `json:"args"`
	Options  any      `json:"options"`
}

LSPConfig defines configuration for Language Server Protocol integration.

type MCPServer ¶

type MCPServer struct {
	Command string            `json:"command"`
	Env     []string          `json:"env"`
	Args    []string          `json:"args"`
	Type    MCPType           `json:"type"`
	URL     string            `json:"url"`
	Headers map[string]string `json:"headers"`
}

MCPServer defines the configuration for a Model Control Protocol server.

type MCPType ¶

type MCPType string

MCPType defines the type of MCP (Model Control Protocol) server.

const (
	MCPStdio MCPType = "stdio"
	MCPSse   MCPType = "sse"
)

Supported MCP types

type ProjectInitFlag ¶

type ProjectInitFlag struct {
	Initialized bool `json:"initialized"`
}

ProjectInitFlag represents the initialization status for a project directory

type Provider ¶

type Provider struct {
	APIKey   string `json:"apiKey"`
	Disabled bool   `json:"disabled"`
}

Provider defines configuration for an LLM provider.

type ShellConfig ¶ added in v0.0.47

type ShellConfig struct {
	Path string   `json:"path,omitempty"`
	Args []string `json:"args,omitempty"`
}

ShellConfig defines the configuration for the shell used by the bash tool.

type TUIConfig ¶ added in v0.0.37

type TUIConfig struct {
	Theme string `json:"theme,omitempty"`
}

TUIConfig defines the configuration for the Terminal User Interface.

Source Files ¶

View all Source files

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