utils

Documentation

Index

• Variables
• func BackupDotfilesSecrets(opts DotfilesSecretsOptions) error
• func CheckBitwardenLoginStatus() (bool, error)
• func DoctorDotfilesSecrets(opts DotfilesSecretsOptions) error
• func EnsureBitwardenSession() (string, error)
• func ExtractSSHKeyFromItem(item *BitwardenItem) (string, error)
• func IsVerbose(cmd *cobra.Command) bool
• func RestoreDotfilesSecrets(opts DotfilesSecretsOptions) error
• func SaveOrUpdateBitwardenSecret(name, secret, notes string) (string, error)
• func StartChildProcess(c *exec.Cmd) error
• func SyncDirectory(srcDir, destDir string, isVerbose bool) error
• func UnlockBitwardenVault() error
• func VerifyBitwardenSession(sess string) error
• type BitwardenField
• type BitwardenItem
  • func FindSSHKeysInVault() ([]BitwardenItem, error)
  • func GetBitwardenItem(name string) (*BitwardenItem, error)
  • func ListBitwardenItems() ([]BitwardenItem, error)
• type BitwardenLogin
• type BitwardenSSHKey
• type DotfilesSecretsEntry
• type DotfilesSecretsManifest
  • func LoadDotfilesSecretsManifest(manifestPath string) (*DotfilesSecretsManifest, error)
• type DotfilesSecretsOptions
• type Spinner
  • func NewProgressSpinner(message string) *Spinner
  • func NewSpinner(message string) *Spinner
  • func (s *Spinner) Logf(format string, a ...interface{})
  • func (s *Spinner) SetProgressBar(progress float64, msg ...string)
  • func (s *Spinner) Start()
  • func (s *Spinner) Stop()
  • func (s *Spinner) UpdateMessage(msg string)

Variables

var Out io.Writer = os.Stderr

Out is the writer used for spinner output. Tests may replace it.

Functions

func BackupDotfilesSecrets

func BackupDotfilesSecrets(opts DotfilesSecretsOptions) error

BackupDotfilesSecrets reads configured env files and saves their managed keys to bws.

func CheckBitwardenLoginStatus

func CheckBitwardenLoginStatus() (bool, error)

CheckBitwardenLoginStatus checks if the user is logged into Bitwarden.

func DoctorDotfilesSecrets

func DoctorDotfilesSecrets(opts DotfilesSecretsOptions) error

DoctorDotfilesSecrets validates manifest-driven secret mappings and templates.

func EnsureBitwardenSession

func EnsureBitwardenSession() (string, error)

EnsureBitwardenSession ensures the Bitwarden vault is unlocked and returns a session key. It first checks BW_SESSION and status; if locked, it prompts for the master password using `bw unlock --raw` and returns the session token. If unauthenticated, it attempts `bw login`.

func ExtractSSHKeyFromItem

func ExtractSSHKeyFromItem(item *BitwardenItem) (string, error)

ExtractSSHKeyFromItem extracts SSH private key from a Bitwarden item.

func IsVerbose

func IsVerbose(cmd *cobra.Command) bool

IsVerbose checks if the "verbose" flag is set for the given Cobra command. It first checks if the verbose flag is explicitly set on the command. If not, it falls back to the config value using viper.

Parameters:

• cmd: A pointer to a Cobra command from which the "verbose" flag is retrieved.

Returns:

• bool: True if the "verbose" flag is set to true, otherwise false.

func RestoreDotfilesSecrets

func RestoreDotfilesSecrets(opts DotfilesSecretsOptions) error

RestoreDotfilesSecrets recreates managed env files from templates and bws values.

func SaveOrUpdateBitwardenSecret

func SaveOrUpdateBitwardenSecret(name, secret, notes string) (string, error)

SaveOrUpdateBitwardenSecret saves a secret value into Bitwarden under the given item name. If the item exists, it will be updated; otherwise it is created. A custom field named "eng-cli" with value "true" is added to tag usage by this CLI.

func StartChildProcess

func StartChildProcess(c *exec.Cmd) error

StartChildProcess starts a child process with the given exec.Cmd configuration. It sets up the standard input, output, and error streams to be the same as the parent process. Additionally, it captures interrupt signals (ctl + c) and forwards them to the child process.

Parameters:

• c: A pointer to an exec.Cmd struct representing the command to be executed.

Returns:

• error: An error if the command fails to start or exits with a non-zero status. Returns nil if the command completes successfully.

The function starts the command and waits for it to finish.

func SyncDirectory

func SyncDirectory(srcDir, destDir string, isVerbose bool) error

SyncDirectory synchronizes the contents of the source directory (srcDir) with the destination directory (destDir). It copies files and recursively syncs subdirectories. If isVerbose is true, it logs the files being copied.

Parameters:

• srcDir: The source directory to sync from.
• destDir: The destination directory to sync to.
• isVerbose: A boolean flag to enable verbose logging.

Returns:

• error: An error if any occurs during the synchronization process., otherwise nil.

func UnlockBitwardenVault

func UnlockBitwardenVault() error

UnlockBitwardenVault prompts the user to unlock their Bitwarden vault.

func VerifyBitwardenSession

func VerifyBitwardenSession(sess string) error

VerifyBitwardenSession checks if the current Bitwarden session is still valid.

Types

type BitwardenField

type BitwardenField struct {
	Name  string `json:"name"`
	Value string `json:"value"`
	Type  int    `json:"type"`
}

BitwardenField represents a custom field in a Bitwarden item.

type BitwardenItem

type BitwardenItem struct {
	ID     string           `json:"id"`
	Name   string           `json:"name"`
	Type   int              `json:"type,omitempty"`
	Fields []BitwardenField `json:"fields,omitempty"`
	Login  *BitwardenLogin  `json:"login,omitempty"`
	Notes  string           `json:"notes,omitempty"`
	SSHKey *BitwardenSSHKey `json:"sshKey,omitempty"`
}

BitwardenItem represents a Bitwarden vault item.

func FindSSHKeysInVault

func FindSSHKeysInVault() ([]BitwardenItem, error)

FindSSHKeysInVault searches for SSH key items in the Bitwarden vault.

func GetBitwardenItem

func GetBitwardenItem(name string) (*BitwardenItem, error)

GetBitwardenItem retrieves an item from Bitwarden vault by name.

func ListBitwardenItems

func ListBitwardenItems() ([]BitwardenItem, error)

ListBitwardenItems returns all items in the vault (filtered by type if specified).

type BitwardenLogin

type BitwardenLogin struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

BitwardenLogin represents login credentials.

type BitwardenSSHKey

type BitwardenSSHKey struct {
	PrivateKey  string `json:"privateKey,omitempty"`
	PublicKey   string `json:"publicKey,omitempty"`
	Fingerprint string `json:"fingerprint,omitempty"`
}

BitwardenSSHKey represents native SSH key payloads in Bitwarden items.

type DotfilesSecretsEntry

type DotfilesSecretsEntry struct {
	RelativeFile string
	Prefix       string
	Keys         []string
}

DotfilesSecretsEntry maps one env file to a bws prefix and the keys that should be managed.

type DotfilesSecretsManifest

type DotfilesSecretsManifest struct {
	ProjectID string
	Entries   []DotfilesSecretsEntry
}

DotfilesSecretsManifest defines the tracked secret mappings for dotfiles env files.

func LoadDotfilesSecretsManifest

func LoadDotfilesSecretsManifest(manifestPath string) (*DotfilesSecretsManifest, error)

LoadDotfilesSecretsManifest parses the tracked manifest used for dotfiles secrets backup and restore.

type DotfilesSecretsOptions

type DotfilesSecretsOptions struct {
	ManifestPath string
	RootPath     string
	ProjectID    string
	Verbose      bool
	UseSpinner   bool
}

DotfilesSecretsOptions configures manifest-driven backup and restore operations.

type Spinner

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

Spinner wraps the mpb.Progress container and a single bar. It's designed to manage a single progress bar and allow logging messages above the bar without disrupting it.

func NewProgressSpinner

func NewProgressSpinner(message string) *Spinner

NewProgressSpinner creates a spinner that displays progress as a bar.

func NewSpinner

func NewSpinner(message string) *Spinner

NewSpinner creates a new spinner with a default indeterminate style.

func (*Spinner) Logf

func (s *Spinner) Logf(format string, a ...interface{})

Logf prints a formatted message above the progress bar.

func (*Spinner) SetProgressBar

func (s *Spinner) SetProgressBar(progress float64, msg ...string)

SetProgressBar sets the progress of the bar. Progress should be from 0.0 to 1.0.

func (*Spinner) Start

func (s *Spinner) Start()

Start does nothing in this implementation, as the bar is visible on creation.

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop marks the bar as completed and waits for the progress container to finish.

func (*Spinner) UpdateMessage

func (s *Spinner) UpdateMessage(msg string)

UpdateMessage updates the message displayed next to the spinner/bar.