config

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2026 License: MIT Imports: 9 Imported by: 0

README

pkg/config

Configuration management for two separate config systems: Confab's own config and Claude Code's settings (hooks).

Files

File Role
config.go Claude Code settings management: read/write ~/.claude/settings.json, hook install/uninstall
upload.go Confab config: read/write ~/.confab/config.json, validation, default redaction patterns
paths.go Path resolution with environment variable overrides

Two Config Systems

Confab config (~/.confab/config.json)

Managed by upload.go. Contains backend URL, API key, log level, auto-update flag, and redaction settings. This is Confab's own config — we control the schema entirely.

Claude Code settings (~/.claude/settings.json)

Managed by config.go. Contains hooks that Claude Code reads to fire events. We install/uninstall hooks here, but Claude Code owns the file and other tools may write to it concurrently.

Key Types

  • UploadConfig — Confab's configuration (backend URL, API key, redaction settings)
  • ClaudeSettings — Wrapper around map[string]any for Claude Code settings, preserving unknown fields
  • RedactionConfig — Redaction enabled flag, use_default_patterns, custom pattern list
  • RedactionPattern — Individual redaction pattern (name, regex, type, capture group, field pattern)

How to Extend

Adding a new Confab config field
  1. Add the field to UploadConfig in upload.go
  2. Add validation in SaveUploadConfig() if needed
  3. Update the setup flow in cmd/setup.go to prompt for / set the field
Adding a new hook type

This spans multiple packages. On the config side:

  1. Add Install<Name>Hook() in config.go — follow the pattern of existing hooks:
    • SessionStart/SessionEnd use "*" matchers
    • PreToolUse/PostToolUse use tool name matchers (e.g., Bash, mcp__github)
    • UserPromptSubmit has no matcher
  2. Add Uninstall<Name>Hook() — must handle both old and new command patterns
  3. Add Is<Name>HookInstalled() — for status checking
  4. Then update: cmd/hooks.go (install/uninstall calls), cmd/status.go (status check), cmd/setup.go (setup flow), cmd/hook.go (dispatch)

Invariants

  • Settings writes must use AtomicUpdateSettings(). This provides read-modify-write with mtime-based optimistic locking and exponential backoff retry (max 10 attempts). Never read + write separately — concurrent Claude Code sessions will clobber each other.
  • Hook install must be idempotent. If the hook already exists, update it in place. Never duplicate hooks.
  • Hook uninstall must handle old command patterns. Users may have hooks installed by older Confab versions with different command strings. Uninstall must find and remove these too.
  • Config file permissions: 0600 for ~/.confab/config.json (contains API key), 0644 for ~/.claude/settings.json (needs to be readable by Claude Code).
  • GetDefaultRedactionPatterns() pattern order matters. More specific patterns (e.g., sk-ant-api03-...) must come before general ones (e.g., field-name-based patterns) to avoid partial matches.

Design Decisions

ClaudeSettings uses map[string]any instead of typed structs. Claude Code's settings schema evolves rapidly and includes fields we don't manage. A typed struct would silently drop unknown fields on round-trip. The raw map preserves everything.

Mtime-based optimistic locking instead of flock. AtomicUpdateSettings() checks that the file's mtime hasn't changed between read and write. If it has, it retries with backoff. This is simpler than file locking, works cross-platform, and is sufficient for the infrequent writes that hooks installation involves.

Hook matchers vary by type. SessionStart/SessionEnd use "*" (fire for all events). PreToolUse/PostToolUse use tool name arrays to target specific tools (e.g., ["Bash"], ["mcp__github"]). UserPromptSubmit has no matcher (fires for all prompts). This matches Claude Code's hook specification.

Testing

go test ./pkg/config/...

Tests cover hook installation/uninstallation, atomic updates under concurrency, field preservation across round-trips, and config validation.

Dependencies

Uses: standard library only

Used by: cmd/ (setup, login, hooks, status), pkg/discovery/ (paths), pkg/sync/ (upload config), pkg/daemon/ (state dir), pkg/logger/ (log level)

Documentation

Index

Constants

View Source 
const (
	ToolNameBash              = "Bash"
	ToolNameMCPGitHubCreatePR = "mcp__github__create_pull_request"
)

Tool names for PreToolUse hook matching

View Source 
const ClaudeStateDirEnv = "CONFAB_CLAUDE_DIR"

ClaudeStateDirEnv is the environment variable to override the default Claude state directory

View Source 
const DisableLinkFromGitHubEnv = "CONFAB_DISABLE_LINK_FROM_GITHUB"

DisableLinkFromGitHubEnv is the environment variable to disable GitHub linking. When set to any non-empty value, GitHub linking (commits and PRs) is disabled.

Variables

This section is empty.

Functions

func ApplyLogLevel 

func ApplyLogLevel()

ApplyLogLevel reads the log level from config and applies it to the logger

func AtomicUpdateSettings 

func AtomicUpdateSettings(updateFn func(*ClaudeSettings) error) error

AtomicUpdateSettings performs a read-modify-write with optimistic locking. It retries up to maxRetries times if the file is modified by another process. The updateFn receives the current settings and should modify them in-place.

Race condition limitation: The mtime check and rename are not truly atomic. There's a small window (<1ms) between os.Stat() and os.Rename() where another process could modify the file. The retry mechanism mitigates but does not eliminate this race. For most use cases (CLI hook installation, infrequent config changes), the retry logic provides sufficient reliability. If truly atomic updates are required, file locking (flock) would be needed.

func EnsureDefaultRedaction 

func EnsureDefaultRedaction() (bool, error)

EnsureDefaultRedaction ensures the config has a redaction section with defaults. If redaction config already exists (even if disabled), it's left unchanged. Returns true if defaults were added, false if config already had redaction settings.

func GetBinaryPath 

func GetBinaryPath() (string, error)

GetBinaryPath returns the absolute path to the confab binary

func GetClaudeSettingsPath 

func GetClaudeSettingsPath() (string, error)

GetSettingsPath returns the path to the Claude settings file

func GetClaudeStateDir 

func GetClaudeStateDir() (string, error)

GetClaudeStateDir returns the Claude state directory path. Defaults to ~/.claude but can be overridden with CONFAB_CLAUDE_DIR env var. This is useful for testing and non-standard installations.

func GetProjectsDir 

func GetProjectsDir() (string, error)

GetProjectsDir returns the path to the Claude projects directory

func GetSettingsPath 

func GetSettingsPath() (string, error)

GetSettingsPath returns the path to the Claude settings file (defaults to ~/.claude/settings.json, can be overridden with CONFAB_CLAUDE_DIR)

func InstallPostToolUseHooks 

func InstallPostToolUseHooks() error

InstallPostToolUseHooks installs the PostToolUse hook for GitHub link tracking. This installs hooks with "Bash" and MCP matchers to capture PR creation output.

func InstallPreToolUseHooks 

func InstallPreToolUseHooks() error

InstallPreToolUseHooks installs the PreToolUse hook for git commit validation. This installs a hook with a "Bash" matcher to intercept git commit commands.

func InstallSyncHooks 

func InstallSyncHooks() error

InstallSyncHooks installs hooks for incremental sync daemon This installs both SessionStart (to start daemon) and SessionEnd (to stop daemon)

func InstallUserPromptSubmitHook 

func InstallUserPromptSubmitHook() error

InstallUserPromptSubmitHook installs the UserPromptSubmit hook. Unlike other hooks, UserPromptSubmit doesn't use matchers.

func IsLinkFromGitHubDisabled 

func IsLinkFromGitHubDisabled() bool

IsLinkFromGitHubDisabled returns true if GitHub linking is disabled via environment variable.

func IsPostToolUseHooksInstalled 

func IsPostToolUseHooksInstalled() (bool, error)

IsPostToolUseHooksInstalled checks if the PostToolUse hook is installed

func IsPreToolUseHooksInstalled 

func IsPreToolUseHooksInstalled() (bool, error)

IsPreToolUseHooksInstalled checks if the PreToolUse hook is installed

func IsSyncHooksInstalled 

func IsSyncHooksInstalled() (bool, error)

IsSyncHooksInstalled checks if sync daemon hooks are installed This checks for both old ("sync start/stop") and new ("hook session-start/end") patterns

func IsUserPromptSubmitHookInstalled 

func IsUserPromptSubmitHookInstalled() (bool, error)

IsUserPromptSubmitHookInstalled checks if the UserPromptSubmit hook is installed

func ParseLogLevel 

func ParseLogLevel(level string) (logger.Level, error)

ParseLogLevel parses a log level string and returns the corresponding logger.Level

func SaveUploadConfig 

func SaveUploadConfig(config *UploadConfig) error

SaveUploadConfig writes upload configuration to ~/.confab/config.json

func UninstallPostToolUseHooks 

func UninstallPostToolUseHooks() error

UninstallPostToolUseHooks removes the PostToolUse hook

func UninstallPreToolUseHooks 

func UninstallPreToolUseHooks() error

UninstallPreToolUseHooks removes the PreToolUse hook

func UninstallSyncHooks 

func UninstallSyncHooks() error

UninstallSyncHooks removes the sync daemon hooks This handles both old ("sync start/stop") and new ("hook session-start/end") patterns

func UninstallUserPromptSubmitHook 

func UninstallUserPromptSubmitHook() error

UninstallUserPromptSubmitHook removes the UserPromptSubmit hook

func ValidateAPIKey 

func ValidateAPIKey(apiKey string) error

ValidateAPIKey checks if the API key format is valid. Confab API keys have the format: cfb_<40 alphanumeric chars> Returns nil for empty string (not configured), but empty is not a valid key.

func ValidateBackendURL 

func ValidateBackendURL(backendURL string) error

ValidateBackendURL checks if the backend URL is valid

Types

type ClaudeSettings 

type ClaudeSettings struct {
	// contains filtered or unexported fields
}

ClaudeSettings wraps the raw settings map to preserve all fields. This is similar to Python's json.load/json.dump pattern. We intentionally avoid typed structs for hooks since the schema is controlled by Claude Code and evolves rapidly.

func ReadSettings 

func ReadSettings() (*ClaudeSettings, error)

ReadSettings reads the Claude settings file, preserving all fields

type RedactionConfig 

type RedactionConfig struct {
	Enabled            bool               `json:"enabled"`
	UseDefaultPatterns *bool              `json:"use_default_patterns,omitempty"` // defaults to true if nil
	Patterns           []RedactionPattern `json:"patterns,omitempty"`
}

RedactionConfig holds redaction settings

func (*RedactionConfig) ShouldUseDefaultPatterns 

func (c *RedactionConfig) ShouldUseDefaultPatterns() bool

ShouldUseDefaultPatterns returns true if default patterns should be used. Defaults to true if UseDefaultPatterns is nil.

type RedactionPattern 

type RedactionPattern struct {
	Name         string `json:"name"`
	Pattern      string `json:"pattern,omitempty"`
	Type         string `json:"type"`
	CaptureGroup int    `json:"capture_group,omitempty"`
	FieldPattern string `json:"field_pattern,omitempty"`
}

RedactionPattern represents a single redaction pattern

func GetDefaultRedactionPatterns 

func GetDefaultRedactionPatterns() []RedactionPattern

GetDefaultRedactionPatterns returns the default high-precision redaction patterns

type UploadConfig 

type UploadConfig struct {
	BackendURL string           `json:"backend_url"`
	APIKey     string           `json:"api_key"`
	LogLevel   string           `json:"log_level,omitempty"`   // debug, info, warn, error (default: info)
	AutoUpdate *bool            `json:"auto_update,omitempty"` // nil = enabled (default), false = disabled
	Redaction  *RedactionConfig `json:"redaction,omitempty"`
}

UploadConfig holds backend upload configuration

func EnsureAuthenticated 

func EnsureAuthenticated() (*UploadConfig, error)

EnsureAuthenticated reads the config and verifies it has valid credentials Returns the config if authenticated, or an error if not configured

func GetUploadConfig 

func GetUploadConfig() (*UploadConfig, error)

GetUploadConfig reads upload configuration from ~/.confab/config.json

func (*UploadConfig) IsAutoUpdateEnabled added in v0.10.2 

func (c *UploadConfig) IsAutoUpdateEnabled() bool

IsAutoUpdateEnabled returns whether auto-update is enabled. Defaults to true when AutoUpdate is nil (not set in config).

func (*UploadConfig) Validate 

func (c *UploadConfig) Validate() error

Validate checks if the upload config is valid

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.