install

Documentation

Index

• func Clients() []string
• func IsClaudeResult(r Result) bool
• type Options
• type Result
  • func Apply(root string, opts Options) ([]Result, error)
  • func Plan(root string, opts Options) ([]Result, error)

Functions

func Clients

func Clients() []string

Clients returns the supported client names in stable display order.

func IsClaudeResult

func IsClaudeResult(r Result) bool

IsClaudeResult reports whether r is a Claude Code installation result.

Types

type Options

type Options struct {
	Clients     string
	Workspace   bool
	Scope       string
	DryRun      bool
	ToolProfile string
}

Options controls non-interactive MCP client configuration. Clients accepts "auto", "all", or a comma-separated client list. Scope applies only to the Claude client: "user" invokes "claude mcp add --scope user" to register in ~/.claude.json; any other value writes a project-local .mcp.json.

type Result

type Result struct {
	Client string
	Path   string
	Action string
	Detail string
}

Result records one client configuration file updated by the installer.

func Apply

func Apply(root string, opts Options) ([]Result, error)

Apply writes DocGraph MCP configuration for the selected clients. The installer is intentionally non-interactive so it can be used from scripted setup flows and tested without terminal prompts.

func Plan

func Plan(root string, opts Options) ([]Result, error)

Plan returns the installer actions without writing files or invoking external commands. It is used for dry-run output and interactive conflict review.