Struct toml_bombadil::Bombadil

pub struct Bombadil { /* fields omitted */ }

The main crate struct, it contains all needed medata about a dotfile directory and how to install it.

Implementations

impl Bombadil

pub fn install_from_remote(
    remote: &str,
    path: PathBuf,
    profiles: Option<Vec<&str>>
) -> Result<()>

Given a git remote address, will clone the repository to the target path and install the dotfiles according to the “bombadil.toml” configuration inside the repo root.

pub fn link_self_config(dotfiles_path: Option<PathBuf>) -> Result<()>

Symlink bombadil.toml to $XDG_CONFIG/bombadil.toml so we can later read it from there.

pub fn install(&self) -> Result<()>

The installation process is composed of the following steps :

1. Run pre install hooks
2. If any previous state is found in .dot/previous_state.toml, remove the existing symlinks
3. Clean existing rendered dotfiles templates in .dot
4. Copy and symlink dotfiles according to the current $XDG_CONFIG/bombadil.toml configuration
5. Run post install hooks
6. Write current state to .dot/previous_state.toml

pub fn uninstall(&self) -> Result<()>

Unlink dotfiles according to previous state

pub fn add_secret<S: AsRef<Path> + ?Sized>(
    &self,
    key: &str,
    value: &str,
    var_file: &S
) -> Result<()>

Add a gpg secret encrypted variable to the target variable file

pub fn display_vars(&self)

Pretty print current bombadil variables

pub fn enable_profiles(&mut self, profile_keys: Vec<&str>) -> Result<()>

Enable a dotfile profile by merging its config with the default profile

pub fn from_settings(mode: Mode) -> Result<Bombadil>

Load Bombadil config from a bombadil.toml

pub fn print_metadata(&self, metadata_type: MetadataType)

Pretty print metadata, possible values are Dots, PreHooks, PostHook, Path, Profiles, Vars, Secrets