machine_setup 0.1.6

A tool for configuring and setting up your machine.
machine_setup-0.1.6 is not a library.

Machine Setup

Tests Crates.io

The idea is to be able to replicate a certain setup (when reseting your machine or using a completely new machine).
Additionally, it should be possible to update the setup easily when needed, e.g. an update to your vim config files.
So, it will help with managing dotfiles, symlinks, etc.

It can also be used for other tasks, e.g. to ease the onboarding process of a new colleague by providing a config that installs certain dependencies and checks out important repositories.

Install

For now, only cargo install is supported.

cargo install machine_setup

Run

Subcommands:

command description example
install install the defined tasks machine_setup install
update update the defined tasks machine_setup update
uninstall uninstall the defined tasks machine_setup uninstall
list list all of the defined tasks machine_setup list

By default, machine_setup will look for a file called machine_setup.yaml.

Command line parameters:

flag value example
-c --config specify a different path to the config file machine_setup install -c ./config/my_setup.yaml
-t --task only run the specified task machine_setup install -t my_task2
-h --help display help information machine_setup --help
-v --version display version information machine_setup --version

Configure

Tasks can be defined under the tasks root key.
Every task can contain an arbitrary number of commands.

Hint
Currently, there can only be one command of the same type per task.
The last command in a task will take precedence.
This is an open bug and will be fixed in a future release.

Check out the example configuration below:

tasks:
  my_task1:
    copy:
      src: "./src/files"
      target: "/tmp/target"

  my_task2:
    shell: "sudo apt-get install git -y"

    symlink:
      src: "./src/config"
      target: "~/.dotfiles"

Available config commands

copy

This command copies the contents of a directory to another directory.

argument value required example
src source directory ✅ "./src/files"
target target directory ✅ "/tmp/target"
ignore list of files/directories to ignore ➖ ["dist", "package-lock.json"]
example
copy:
  src: "./src/files"
  target: "/tmp/target"
  ignore: ["dist", "package-lock.json"]

clone

This command clones a git repository to the specified destination.

argument value required example
url URL to a git repository ✅ "git@github.com:Chroma91/machine_setup.git"
target target directory ✅ "~/machine_setup"
example
clone:
  url: "git@github.com:Chroma91/machine_setup.git"
  target: "~/machine_setup"

symlink

This command symlinks all the files from the source directory to the target directory.

argument value required example
src source directory ✅ "./src/files"
target target directory ✅ "/tmp/target"
ignore list of files/directories to ignore ➖ ["dist", "package-lock.json"]
example
symlink:
  src: "./src/files"
  target: "/tmp/target"
  ignore: ["dist", "package-lock.json"]

shell

This command executes a shell command.

Hint: Avoid the usage of interactive commands when possible.

By default, shell commands will be skipped when updating or uninstalling.
You can change that by prodiving update and/or uninstall.

argument value required example
install command for installing ➖ "sudo apt-get -y install git"
update command for updating ➖ "sudo apt-get -y upgrade git"
uninstall command for uninstalling ➖ "sudo apt-get -y uninstall git"
env environment variables ➖ SOME_TOKEN: 'abc123'
example
inline_command:
  shell: "sudo apt-get -y install git"

multiline_command:
  shell:
    - "sudo apt-get update"
    - "sudo apt-get -y install git"

updatable_command:
  shell:
    env:
      SOME_TOKEN: "abc123"
    install: "sudo apt-get -y install git"
    update: "sudo apt-get -y upgrade git"
    uninstall: "sudo apt-get -y uninstall git"

updatable_multiline_command:
  shell:
    env:
      SOME_TOKEN: "abc123"
    install:
      - "sudo apt update"
      - "sudo apt-get -y install git"
    update:
      - "sudo apt-get -y upgrade git"
      - ...
    uninstall:
      - "sudo apt-get -y uninstall git"
      - ...

TODOs

  • Add other binaries and installation options
  • Theoretically, other config formats can be used. However, a lot of the types are still hardcoded to Yaml...