80 releases (15 stable)

1.6.0 May 25, 2024
1.5.3 Feb 7, 2024
1.4.3 Jan 31, 2024
1.4.2 Nov 14, 2021
0.2.7 Nov 30, 2019

#17 in Command line utilities

AGPL-3.0-or-later

135KB
3K SLoC

emplace

Command-line tool to mirror installed software on multiple machines.

Build Status Downloads Version


Features

  • Outputs a human-readable (RON) file to sync between machines: .emplace

  • Version control with git to automatically push & pull updates

  • Automatic prompt after installing a package

  • Integrates well with dotfiles repositories

  • Parses history file

  • Package managers supported:

    OS Package Manager
    Apt
    GNU Guix
    Nix
    Pacman
    Paru
    RUA
    Yay
    Zypper
    Snap
    DNF/YUM
    Homebrew
    Pkg
    Chocolatey
    Scoop
    Cargo
    Cargo B(inary)Install
    Rustup Component
    Python Pip
    Python Pip 3
    Node Package Manager
    Ruby Gem
    Go
  • Shells supported:

    Shell
    Bash
    Zsh
    Fish
    Nu

Installation Packaging status

Getting Started

  1. Install the emplace binary:

    Windows

    Scoop

    scoop install emplace
    

    NixOS

    nix-env -iA nixos.emplace
    

    Linux, MacOS, Windows

    Rust

    cargo install emplace
    

    Binary

    Download the latest binary from releases for your OS and put it somewhere in your PATH.

  2. Add the init script to your shell's config file:

    Bash

    Add the following to the end of ~/.bashrc:

    # ~/.bashrc
    
    source <(emplace init bash)
    

    Zsh

    Add the following to the end of ~/.zshrc:

    # ~/.zshrc
    
    eval "$(emplace init zsh)"
    

    Fish

    Add the following to the end of ~/.config/fish/config.fish:

    # ~/.config/fish/config.fish
    
    emplace init fish | source
    

    Nu

    Run the following in your shell:

    emplace init nu | config set_into prompt
    
  3. Change the configuration file (optional)

    When you want to use a different configuration file from the default one you can change emplace init $SHELL with emplace init $SHELL -c path/to/my/config.toml.

    This will set the EMPLACE_CONFIG="path/to/my/config.toml" environment variable. This can be overwritten with export EMPLACE_CONFIG="path/to/other/config.toml" after the init function, except in the Nu shell.

Usage

Mirroring Packages

Invoke the supported package manager of choice using the command line in a normal way and you will automatically be prompted to mirror the package, for example:

cargo install topgrade
# -- or --
cargo binstall zellij
# -- or --
rustup component add rustfmt
# -- or --
sudo apt install meld
# -- or --
pacman -S zsh
# -- or --
paru -S ventoy
# -- or --
rua install peek
# -- or --
yay -S thunar
# -- or --
sudo snap install scrcpy
# -- or --
npm install -g release
# -- or --
pip3 install --user termtosvg
# -- or --
choco install neovim
# -- or --
scoop install curl
# -- or --
nix-env -iA nixpkgs.nixfmt
# -- or --
brew install wget
# -- or --
sudo dnf install htop
# -- or --
guix install 0ad
# -- or --
gem install aasm-diagram
# -- or --
go get colorgo
# -- or --
pkg install nginx

Synchronizing On Another Machine

Just invoke emplace install, and you will be prompted with the packages to install:

emplace install

History Analysis

You can also parse history files, this will try to extract installation commands from each line.

Bash & Zsh

emplace history $HISTFILE

Fish

emplace history ~/.local/share/fish/fish_history

Removing Synchronized Packages

Run emplace clean and select the packages you want to be cleaned, they won't be removed from your system.

Creating and modifying config files

Run emplace config --new to create a new config and configure the repository or emplace config --path to retrieve the path to the configuration file.

Development Status

This software isn't actively developed on by me anymore, I do however review and accept pull requests.

Contributors

Thanks goes to these wonderful people (emoji key):


Logan Magee

πŸ’» πŸ›

Vladimir

πŸ“¦ πŸ’» πŸ› 🚧 πŸ‘€

Jozef HollΓ½

πŸ€”

Oleksii Filonenko

πŸ’» πŸ“¦ πŸ‘€

x0f5c3

πŸ’»

Benjamin S. Leveritt

πŸ€” 🚧

Michael Borejdo

πŸ€”

Ken Tobias

πŸ“¦

Adam Stephens

πŸ›

omar

πŸ›

5c0tt-b0t

πŸ€” πŸ›

Modded Gamers

πŸ›

John Vandenberg

πŸ› πŸ€”

cryolithic

πŸ“¦

This project follows the all-contributors specification. Contributions of any kind welcome!

Dependencies

~9–18MB
~228K SLoC