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

dot

package

Go to main page

Versions in this module

v0

v0.6.3

Nov 24, 2025

Changes in this version

+ func GetConfigPath(appName string) string

+ func UntranslateDotfile(name string) string

+ func UpgradeConfig(configPath string, force bool) (string, error)

+ type ConfigLoader struct

+ func NewConfigLoader(appName, configPath string) *ConfigLoader

+ func (l *ConfigLoader) LoadWithEnv() (*ExtendedConfig, error)

+ type ConfigWriter struct

+ func NewConfigWriter(path string) *ConfigWriter

+ func (w *ConfigWriter) Update(key, value string) error

+ func (w *ConfigWriter) WriteDefault(opts config.WriteOptions) error

+ type ExtendedConfig = config.ExtendedConfig

+ func DefaultExtendedConfig() *ExtendedConfig

+ func LoadExtendedFromFile(path string) (*ExtendedConfig, error)

type FS

+ func NewOSFilesystem() FS

+ type GitHubRelease = updater.GitHubRelease

type Logger

+ func NewJSONLogger(w io.Writer, level slog.Level) Logger

+ func NewNoopLogger() Logger

+ func NewSlogLogger(l *slog.Logger) Logger

+ func NewTextLogger(w io.Writer, level slog.Level) Logger

+ type PackageManager = updater.PackageManager

+ func ResolvePackageManager(configured string) (PackageManager, error)

+ type SecretDetection = doctor.SecretDetection

+ func DetectSecrets(files []string, patterns []SensitivePattern) []SecretDetection

+ type SensitivePattern = doctor.SensitivePattern

+ func DefaultSensitivePatterns() []SensitivePattern

+ type StartupChecker struct

+ func NewStartupChecker(currentVersion string, cfg *ExtendedConfig, configDir string, output io.Writer) *StartupChecker

+ func (c *StartupChecker) Check() (*UpdateCheckResult, error)

+ func (c *StartupChecker) ShowNotification(result *UpdateCheckResult)

+ type UpdateCheckResult = updater.CheckResult

+ type VersionChecker struct

+ func NewVersionChecker(repository string) *VersionChecker

+ func (v *VersionChecker) CheckForUpdate(currentVersion string, includePrerelease bool) (*GitHubRelease, bool, error)

+ type WriteOptions = config.WriteOptions

v0.6.2

Nov 24, 2025

v0.6.1

Nov 24, 2025

v0.6.0

Nov 24, 2025

Changes in this version

+ const NodeDir

+ const NodeFile

+ const NodeSymlink

+ const OpKindDirCopy

+ const OpKindDirCreate

+ const OpKindDirDelete

+ const OpKindDirRemoveAll

+ const OpKindFileBackup

+ const OpKindFileDelete

+ const OpKindFileMove

+ const OpKindLinkCreate

+ const OpKindLinkDelete

+ func IsManifestNotFoundError(err error) bool

+ func UserFacingError(err error) string

+ type AdoptService struct

+ func (s *AdoptService) Adopt(ctx context.Context, files []string, pkg string) error

+ func (s *AdoptService) GetManagedPaths(ctx context.Context) (map[string]bool, error)

+ func (s *AdoptService) PlanAdopt(ctx context.Context, files []string, pkg string) (Plan, error)

+ type Attribute = domain.Attribute

+ type BootstrapResult struct

+ Config bootstrap.Config

+ InstalledCount int

+ PackageCount int

+ YAML []byte

+ type BootstrapService struct

+ func (s *BootstrapService) GenerateBootstrap(ctx context.Context, opts GenerateBootstrapOptions) (BootstrapResult, error)

+ func (s *BootstrapService) WriteBootstrap(ctx context.Context, data []byte, outputPath string) error

+ type Client struct

+ func NewClient(cfg Config) (*Client, error)

+ func (c *Client) Adopt(ctx context.Context, files []string, pkg string) error

+ func (c *Client) Clone(ctx context.Context, repoURL string, opts CloneOptions) error

+ func (c *Client) Config() Config

+ func (c *Client) Doctor(ctx context.Context) (DiagnosticReport, error)

+ func (c *Client) DoctorWithMode(ctx context.Context, mode DiagnosticMode, scanCfg ScanConfig) (DiagnosticReport, error)

+ func (c *Client) DoctorWithScan(ctx context.Context, scanCfg ScanConfig) (DiagnosticReport, error)

+ func (c *Client) GenerateBootstrap(ctx context.Context, opts GenerateBootstrapOptions) (BootstrapResult, error)

+ func (c *Client) List(ctx context.Context) ([]PackageInfo, error)

+ func (c *Client) Manage(ctx context.Context, packages ...string) error

+ func (c *Client) PlanAdopt(ctx context.Context, files []string, pkg string) (Plan, error)

+ func (c *Client) PlanManage(ctx context.Context, packages ...string) (Plan, error)

+ func (c *Client) PlanRemanage(ctx context.Context, packages ...string) (Plan, error)

+ func (c *Client) PlanUnmanage(ctx context.Context, packages ...string) (Plan, error)

+ func (c *Client) Remanage(ctx context.Context, packages ...string) error

+ func (c *Client) Status(ctx context.Context, packages ...string) (Status, error)

+ func (c *Client) Triage(ctx context.Context, scanCfg ScanConfig, opts TriageOptions) (TriageResult, error)

+ func (c *Client) Unmanage(ctx context.Context, packages ...string) error

+ func (c *Client) UnmanageAll(ctx context.Context, opts UnmanageOptions) (int, error)

+ func (c *Client) UnmanageWithOptions(ctx context.Context, opts UnmanageOptions, packages ...string) error

+ func (c *Client) WriteBootstrap(ctx context.Context, data []byte, outputPath string) error

+ type CloneOptions struct

+ Branch string

+ Force bool

+ Interactive bool

+ Profile string

+ type CloneService struct

+ func (s *CloneService) Clone(ctx context.Context, repoURL string, opts CloneOptions) error

+ type Config struct

+ Backup bool

+ BackupDir string

+ Concurrency int

+ DryRun bool

+ FS FS

+ Folding bool

+ IgnorePatterns []string

+ InteractiveLargeFiles bool

+ LinkMode LinkMode

+ Logger Logger

+ ManifestDir string

+ MaxFileSize int64

+ Metrics Metrics

+ Overwrite bool

+ PackageDir string

+ PackageNameMapping bool

+ PerPackageIgnore bool

+ TargetDir string

+ Tracer Tracer

+ UseDefaultIgnorePatterns bool

+ Verbosity int

+ func (c Config) Validate() error

+ func (c Config) WithDefaults() Config

+ type ConflictInfo = domain.ConflictInfo

+ type Counter = domain.Counter

+ type DiagnosticMode string

+ const DiagnosticDeep

+ const DiagnosticFast

+ type DiagnosticReport struct

+ Issues []Issue

+ OverallHealth HealthStatus

+ Statistics DiagnosticStats

+ type DiagnosticStats struct

+ BrokenLinks int

+ ManagedLinks int

+ OrphanedLinks int

+ TotalLinks int

+ type DirCopy = domain.DirCopy

+ func NewDirCopy(id OperationID, source, dest FilePath) DirCopy

+ type DirCreate = domain.DirCreate

+ func NewDirCreate(id OperationID, path FilePath) DirCreate

+ type DirDelete = domain.DirDelete

+ func NewDirDelete(id OperationID, path FilePath) DirDelete

+ type DirEntry = domain.DirEntry

+ type DirRemoveAll = domain.DirRemoveAll

+ func NewDirRemoveAll(id OperationID, path FilePath) DirRemoveAll

+ type DoctorService struct

+ func (s *DoctorService) Doctor(ctx context.Context) (DiagnosticReport, error)

+ func (s *DoctorService) DoctorWithMode(ctx context.Context, mode DiagnosticMode, scanCfg ScanConfig) (DiagnosticReport, error)

+ func (s *DoctorService) DoctorWithScan(ctx context.Context, scanCfg ScanConfig) (DiagnosticReport, error)

+ func (s *DoctorService) Fix(ctx context.Context, scanCfg ScanConfig, opts FixOptions) (FixResult, error)

+ func (s *DoctorService) IgnoreLink(ctx context.Context, linkPath, reason string) error

+ func (s *DoctorService) IgnorePattern(ctx context.Context, pattern string) error

+ func (s *DoctorService) ListIgnored(ctx context.Context) (map[string]manifest.IgnoredLink, []string, error)

+ func (s *DoctorService) PreFlightCheck(ctx context.Context, packages []string) (DiagnosticReport, error)

+ func (s *DoctorService) Triage(ctx context.Context, scanCfg ScanConfig, opts TriageOptions) (TriageResult, error)

+ func (s *DoctorService) UnignoreLink(ctx context.Context, linkPath string) error

+ type ErrAuthFailed struct

+ Cause error

+ func (e ErrAuthFailed) Error() string

+ func (e ErrAuthFailed) Unwrap() error

+ type ErrBootstrapExists struct

+ Path string

+ func (e ErrBootstrapExists) Error() string

+ type ErrBootstrapNotFound struct

+ Path string

+ func (e ErrBootstrapNotFound) Error() string

+ type ErrCheckpointNotFound = domain.ErrCheckpointNotFound

+ type ErrCloneFailed struct

+ Cause error

+ URL string

+ func (e ErrCloneFailed) Error() string

+ func (e ErrCloneFailed) Unwrap() error

+ type ErrConflict = domain.ErrConflict

+ type ErrCyclicDependency = domain.ErrCyclicDependency

+ type ErrEmptyPlan = domain.ErrEmptyPlan

+ type ErrExecutionFailed = domain.ErrExecutionFailed

+ type ErrFilesystemOperation = domain.ErrFilesystemOperation

+ type ErrInvalidBootstrap struct

+ Cause error

+ Reason string

+ func (e ErrInvalidBootstrap) Error() string

+ func (e ErrInvalidBootstrap) Unwrap() error

+ type ErrInvalidPath = domain.ErrInvalidPath

+ type ErrMultiple = domain.ErrMultiple

+ type ErrNotImplemented = domain.ErrNotImplemented

+ type ErrPackageDirNotEmpty struct

+ Cause error

+ Path string

+ func (e ErrPackageDirNotEmpty) Error() string

+ func (e ErrPackageDirNotEmpty) Unwrap() error

+ type ErrPackageNotFound = domain.ErrPackageNotFound

+ type ErrParentNotFound = domain.ErrParentNotFound

+ type ErrPermissionDenied = domain.ErrPermissionDenied

+ type ErrProfileNotFound struct

+ Profile string

+ func (e ErrProfileNotFound) Error() string

+ type ErrSourceNotFound = domain.ErrSourceNotFound

+ type ExecutionResult = domain.ExecutionResult

+ type FS = domain.FS

+ type FileBackup = domain.FileBackup

+ func NewFileBackup(id OperationID, source, backup FilePath) FileBackup

+ type FileDelete = domain.FileDelete

+ func NewFileDelete(id OperationID, path FilePath) FileDelete

+ type FileInfo = domain.FileInfo

+ type FileMove = domain.FileMove

+ func NewFileMove(id OperationID, source TargetPath, dest FilePath) FileMove

+ type FilePath = domain.FilePath

+ func MustParsePath(s string) FilePath

+ type FixOptions struct

+ AutoConfirm bool

+ DryRun bool

+ Interactive bool

+ type FixResult struct

+ Errors map[string]error

+ Fixed []string

+ Skipped []string

+ type Gauge = domain.Gauge

+ type GenerateBootstrapOptions struct

+ ConflictPolicy string

+ Force bool

+ FromManifest bool

+ IncludeComments bool

+ type HealthChecker struct

+ func (h *HealthChecker) CheckLink(ctx context.Context, pkgName, linkPath, packageDir string) LinkHealthResult

+ func (h *HealthChecker) CheckPackage(ctx context.Context, pkgName string, links []string, packageDir string) (bool, string)

+ type HealthStatus int

+ const HealthErrors

+ const HealthOK

+ const HealthWarnings

+ func (h HealthStatus) MarshalJSON() ([]byte, error)

+ func (h HealthStatus) MarshalYAML() (interface{}, error)

+ func (h HealthStatus) String() string

+ type Histogram = domain.Histogram

+ type Issue struct

+ Message string

+ Path string

+ Severity IssueSeverity

+ Suggestion string

+ Type IssueType

+ type IssueSeverity int

+ const SeverityError

+ const SeverityInfo

+ const SeverityWarning

+ func (s IssueSeverity) MarshalJSON() ([]byte, error)

+ func (s IssueSeverity) MarshalYAML() (interface{}, error)

+ func (s IssueSeverity) String() string

+ type IssueType int

+ const IssueBrokenLink

+ const IssueCircular

+ const IssueManifestInconsistency

+ const IssueOrphanedLink

+ const IssuePermission

+ const IssueWrongTarget

+ func (t IssueType) MarshalJSON() ([]byte, error)

+ func (t IssueType) MarshalYAML() (interface{}, error)

+ func (t IssueType) String() string

+ type LinkCreate = domain.LinkCreate

+ func NewLinkCreate(id OperationID, source FilePath, target TargetPath) LinkCreate

+ type LinkDelete = domain.LinkDelete

+ func NewLinkDelete(id OperationID, target TargetPath) LinkDelete

+ type LinkHealthResult struct

+ IsHealthy bool

+ IssueType IssueType

+ Message string

+ Severity IssueSeverity

+ Suggestion string

+ type LinkMode int

+ const LinkAbsolute

+ const LinkRelative

+ type Logger = domain.Logger

+ type ManageService struct

+ func (s *ManageService) Manage(ctx context.Context, packages ...string) error

+ func (s *ManageService) PlanManage(ctx context.Context, packages ...string) (Plan, error)

+ func (s *ManageService) PlanRemanage(ctx context.Context, packages ...string) (Plan, error)

+ func (s *ManageService) Remanage(ctx context.Context, packages ...string) error

+ type ManifestService struct

+ func (s *ManifestService) Load(ctx context.Context, targetPath TargetPath) domain.Result[manifest.Manifest]

+ func (s *ManifestService) RemovePackage(ctx context.Context, targetPath TargetPath, pkg string) error

+ func (s *ManifestService) Save(ctx context.Context, targetPath TargetPath, m manifest.Manifest) error

+ func (s *ManifestService) Update(ctx context.Context, targetPath TargetPath, packageDir string, ...) error

+ func (s *ManifestService) UpdateWithSource(ctx context.Context, targetPath TargetPath, packageDir string, ...) error

+ type Metrics = domain.Metrics

+ func NewNoopMetrics() Metrics

+ type Node = domain.Node

+ type NodeType = domain.NodeType

+ type Operation = domain.Operation

+ type OperationID = domain.OperationID

+ type OperationKind = domain.OperationKind

+ type OrphanGroup struct

+ Category *doctor.PatternCategory

+ Confidence string

+ IsUncategorized bool

+ Links []Issue

+ Pattern string

+ type Package = domain.Package

+ type PackageInfo struct

+ InstalledAt time.Time

+ IsHealthy bool

+ IssueType string

+ LinkCount int

+ Links []string

+ Name string

+ PackageDir string

+ Source string

+ TargetDir string

+ type PackagePath = domain.PackagePath

+ type Plan = domain.Plan

+ type PlanMetadata = domain.PlanMetadata

+ type Result domain.Result[T]

+ func Collect[T any](results []Result[T]) Result[[]T]

+ func Err[T any](err error) Result[T]

+ func FlatMap[T, U any](r Result[T], fn func(T) Result[U]) Result[U]

+ func Map[T, U any](r Result[T], fn func(T) U) Result[U]

+ func NewFilePath(s string) Result[FilePath]

+ func NewPackagePath(s string) Result[PackagePath]

+ func NewTargetPath(s string) Result[TargetPath]

+ func Ok[T any](value T) Result[T]

+ func (r Result[T]) IsErr() bool

+ func (r Result[T]) IsOk() bool

+ func (r Result[T]) Unwrap() T

+ func (r Result[T]) UnwrapErr() error

+ func (r Result[T]) UnwrapOr(defaultValue T) T

+ type ScanConfig struct

+ MaxDepth int

+ MaxIssues int

+ MaxWorkers int

+ Mode ScanMode

+ ScopeToDirs []string

+ SkipPatterns []string

+ func DeepScanConfig(maxDepth int) ScanConfig

+ func DefaultScanConfig() ScanConfig

+ func ScopedScanConfig() ScanConfig

+ type ScanMode int

+ const ScanDeep

+ const ScanOff

+ const ScanScoped

+ func (s ScanMode) String() string

+ type Span = domain.Span

+ type SpanOption = domain.SpanOption

+ type Status struct

+ Packages []PackageInfo

+ type StatusService struct

+ func (s *StatusService) List(ctx context.Context) ([]PackageInfo, error)

+ func (s *StatusService) Status(ctx context.Context, packages ...string) (Status, error)

+ type TargetPath = domain.TargetPath

+ func MustParseTargetPath(s string) TargetPath

+ type Tracer = domain.Tracer

+ func NewNoopTracer() Tracer

+ type TriageOptions struct

+ AutoConfirm bool

+ AutoIgnoreHighConfidence bool

+ DryRun bool

+ type TriageResult struct

+ Adopted map[string]string

+ Errors map[string]error

+ Ignored []string

+ Patterns []string

+ Skipped []string

+ type UnmanageOptions struct

+ Cleanup bool

+ Purge bool

+ Restore bool

+ func DefaultUnmanageOptions() UnmanageOptions

+ type UnmanageService struct

+ func (s *UnmanageService) PlanUnmanage(ctx context.Context, packages ...string) (Plan, error)

+ func (s *UnmanageService) Unmanage(ctx context.Context, packages ...string) error

+ func (s *UnmanageService) UnmanageAll(ctx context.Context, opts UnmanageOptions) (int, error)

+ func (s *UnmanageService) UnmanageWithOptions(ctx context.Context, opts UnmanageOptions, packages ...string) error

+ type WarningInfo = domain.WarningInfo