mirror of
https://github.com/gogrlx/snack.git
synced 2026-04-02 05:08:42 -07:00
Tai Groot
08514a27e1
- Common Manager interface, Package type, functional options - Sentinel errors for common package manager failures - Sub-package stubs for: pacman, aur, apk, apt, dpkg, dnf, rpm, flatpak, snap, pkg (FreeBSD), ports (OpenBSD) - detect/ package for auto-detection of system package manager - 0BSD license
48 lines
1.7 KiB
Go
48 lines
1.7 KiB
Go
// Package snack provides idiomatic Go wrappers for system package managers.
|
|
//
|
|
// Each sub-package wraps a specific package manager's CLI, while the root
|
|
// package defines the common [Manager] interface that all providers implement.
|
|
// Use [detect.Default] to auto-detect the system's package manager.
|
|
package snack
|
|
|
|
import "context"
|
|
|
|
// Manager is the common interface implemented by all package manager wrappers.
|
|
type Manager interface {
|
|
// Install one or more packages.
|
|
Install(ctx context.Context, pkgs []string, opts ...Option) error
|
|
|
|
// Remove one or more packages.
|
|
Remove(ctx context.Context, pkgs []string, opts ...Option) error
|
|
|
|
// Purge one or more packages (remove including config files).
|
|
Purge(ctx context.Context, pkgs []string, opts ...Option) error
|
|
|
|
// Upgrade all installed packages to their latest versions.
|
|
Upgrade(ctx context.Context, opts ...Option) error
|
|
|
|
// Update refreshes the package index/database.
|
|
Update(ctx context.Context) error
|
|
|
|
// List returns all installed packages.
|
|
List(ctx context.Context) ([]Package, error)
|
|
|
|
// Search queries the package index for packages matching the query.
|
|
Search(ctx context.Context, query string) ([]Package, error)
|
|
|
|
// Info returns details about a specific package.
|
|
Info(ctx context.Context, pkg string) (*Package, error)
|
|
|
|
// IsInstalled reports whether a package is currently installed.
|
|
IsInstalled(ctx context.Context, pkg string) (bool, error)
|
|
|
|
// Version returns the installed version of a package.
|
|
Version(ctx context.Context, pkg string) (string, error)
|
|
|
|
// Available reports whether this package manager is present on the system.
|
|
Available() bool
|
|
|
|
// Name returns the package manager's identifier (e.g. "apt", "pacman").
|
|
Name() string
|
|
}
|