config

Documentation

Overview

Package config provides path resolution for Flow's directory structure.

Index

• func SaveFlowConfig(path string, fc *FlowConfig) error
• type Agent
• type Config
  • func New() (*Config, error)
  • func (c *Config) BareRepoPath(repoURL string) string
  • func (c *Config) ClaudeAgentDir() string
  • func (c *Config) EnsureDirs() error
  • func (c *Config) StatePath(name string) string
  • func (c *Config) WorkspacePath(name string) string
  • func (c *Config) WorkspaceStatusSpecPath(id string) string
• type FlowConfig
  • func DefaultFlowConfig() *FlowConfig
  • func LoadFlowConfig(path string) (*FlowConfig, error)
  • func (fc *FlowConfig) DefaultAgent() *Agent
• type FlowConfigSpec

Functions

func SaveFlowConfig

func SaveFlowConfig(path string, fc *FlowConfig) error

SaveFlowConfig writes a FlowConfig to disk as YAML.

Types

type Agent

type Agent struct {
	Name    string `yaml:"name"`
	Exec    string `yaml:"exec"`
	Default bool   `yaml:"default,omitempty"`
}

Agent represents a configured agent tool (editor, AI assistant, etc.).

type Config

type Config struct {
	Home           string      // Root directory (~/.flow or $FLOW_HOME)
	WorkspacesDir  string      // ~/.flow/workspaces/
	ReposDir       string      // ~/.flow/repos/
	AgentsDir      string      // ~/.flow/agents/
	ConfigFile     string      // ~/.flow/config.yaml
	StatusSpecFile string      // ~/.flow/status.yaml
	FlowConfig     *FlowConfig // loaded global config
}

Config holds resolved paths for Flow's directory structure.

func New

func New() (*Config, error)

New creates a Config with resolved paths. Respects $FLOW_HOME if set, otherwise defaults to ~/.flow.

func (*Config) BareRepoPath

func (c *Config) BareRepoPath(repoURL string) string

BareRepoPath returns the bare clone path for a repo URL. e.g., github.com/org/repo → ~/.flow/repos/github.com/org/repo.git Handles URLs that already end in .git (e.g., git@github.com:org/repo.git).

func (*Config) ClaudeAgentDir

func (c *Config) ClaudeAgentDir() string

ClaudeAgentDir returns the path for the shared Claude agent directory.

func (*Config) EnsureDirs

func (c *Config) EnsureDirs() error

EnsureDirs creates the top-level directories if they don't exist. It also creates the default config file if missing, and loads the config.

func (*Config) StatePath

func (c *Config) StatePath(name string) string

StatePath returns the state.yaml path for a named workspace.

func (*Config) WorkspacePath

func (c *Config) WorkspacePath(name string) string

WorkspacePath returns the path for a named workspace.

func (*Config) WorkspaceStatusSpecPath

func (c *Config) WorkspaceStatusSpecPath(id string) string

WorkspaceStatusSpecPath returns the status.yaml path for a workspace.

type FlowConfig

type FlowConfig struct {
	APIVersion string         `yaml:"apiVersion"`
	Kind       string         `yaml:"kind"`
	Spec       FlowConfigSpec `yaml:"spec,omitempty"`
}

FlowConfig represents the global flow configuration file.

func DefaultFlowConfig

func DefaultFlowConfig() *FlowConfig

DefaultFlowConfig returns a FlowConfig with default values.

func LoadFlowConfig

func LoadFlowConfig(path string) (*FlowConfig, error)

LoadFlowConfig reads and parses a flow config file from disk.

func (*FlowConfig) DefaultAgent

func (fc *FlowConfig) DefaultAgent() *Agent

DefaultAgent returns the agent marked as default, or nil if none is configured.

type FlowConfigSpec

type FlowConfigSpec struct {
	Agents []Agent `yaml:"agents,omitempty"`
}

FlowConfigSpec holds optional configuration nested under spec.