# Machine Setup
[](https://github.com/Chroma91/machine-setup/actions/workflows/run_tests.yml) [](https://crates.io/crates/machine_setup)
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.
A real world example can be found in my [.dotfiles repository](https://github.com/Chroma91/.dotfiles/blob/main/machine_setup.yaml).
You can also use it for other tasks such as making the onboarding process of a new colleague easier by providing them a config that installs certain dependencies and checks out important repositories.
## Install
For now, only `cargo install` is supported.
```bash
cargo install machine_setup
```
## Run
Subcommands:
| 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`.
Currently, the supported formats are `YAML` and `JSON`.
Command line parameters:
| -c<br> --config | specify a different path to the config file | `machine_setup install -c ./config/my_setup.yaml` |
| -t<br> --task | only run the specified task | `machine_setup install -t my_task2` |
| -s<br> --select | select a task to run | `machine_setup install -s` |
| -h<br> --help | display help information | `machine_setup --help` |
| -v<br> --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.
| tasks | root key for all of the tasks | |
| default_shell | shell that is used when not specified by the command | `bash`, `zsh` | `bash` |
| temp_dir | define where temporary files are stored | | `~/.machine_setup` |
> **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.
> TODO: Add JSON examples...
Check out the example configuration below:
```yaml
temp_dir: "~/my_temp" # defaults to "~/.machine_setup"
default_shell: "zsh" # defaults to "bash"
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"
```
### Extend a configuration
Extensibility is not explicitly built in.
However, it's possible to execute tasks from another configuration via the `run` command.
You could also only execute a single task by providing the `task` argument.
```yaml
tasks:
my_other_config:
run:
commands:
install: "machine_setup install -c ./my_other_config.yaml"
update: "machine_setup update -c ./my_other_config.yaml"
uninstall: "machine_setup uninstall -c ./my_other_config.yaml"
```
### Available config commands
#### copy
This command copies the contents of a directory to another directory.
| src | source directory/file | ✅ | "./src/files" or "./src/test.txt" |
| target | target directory/file | ✅ | "/tmp/target" or "/tmp/target/new.txt" |
| ignore | list of files/directories to ignore | ➖ | ["dist", "package-lock.json"] |
##### example
```yaml
copy:
src: "./src/files"
target: "/tmp/target"
ignore: ["dist", "package-lock.json"]
```
#### clone
This command clones a git repository to the specified destination.
| url | URL to a git repository | ✅ | "git@github.com:Chroma91/machine_setup.git" |
| target | target directory | ✅ | "~/machine_setup" |
##### example
```yaml
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.
| src | source directory/file | ✅ | "./src/files" or "./src/test.txt" |
| target | target directory/file | ✅ | "/tmp/target" or "/tmp/new.txt" |
| ignore | list of files/directories to ignore | ➖ | ["dist", "package-lock.json"] |
| force | true/false | ➖ | |
> If `force` is set to `true`, existing files will be **removed** and replaced by the symlinks.
##### example
```yaml
symlink:
src: "./src/files"
target: "/tmp/target"
ignore: ["dist", "package-lock.json"]
force: true
```
#### run
This command executes a shell command.
> Hint: Avoid the usage of interactive commands when possible.
| env | environment variables | ➖ | | |
| shell | shell that is used | ➖ | "bash" | "bash", "zsh" |
By default, shell commands will be skipped when updating or uninstalling.
You can change that by prodiving `update` and/or `uninstall`.
The following arguments can be passed to `commands`:
| 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" |
##### example
```yaml
inline_command:
run:
commands: "sudo apt-get -y install git"
multiline_command:
run:
commands:
- "sudo apt-get update"
- "sudo apt-get -y install git"
updatable_command:
run:
env:
SOME_TOKEN: "abc123"
commands:
install: "sudo apt-get -y install git"
update: "sudo apt-get -y upgrade git"
uninstall: "sudo apt-get -y uninstall git"
updatable_multiline_command:
run:
env:
SOME_TOKEN: "abc123"
commands:
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
### 0.4.0
- ~~symlink command: add option to force symlink (delete existing files)~~
- ~~remove hardcoded Yaml types~~
- ~~add JSON support~~
### 0.5.0
- Add option to run `copy` and `symlink` as root user (needed to move/link some system files)
### 0.6.0
- conditional tasks
- add the ability to run tasks for specific OSs, e.g. `os: ['linux', 'osx']`
- add the ability to add requirements for a task, e.g. only run if a certain file doesn't exist
### 1.0.0 1
- Add other binaries and installation options
- Relative paths should be relative to the config file
- Add autocomplete (also for tasks) -> `clap_complete`
- Improve the terminal output
- hide most of it behind a `--verbose` flag
### 1.1.0
- make it possible to specify that all commands in a task should be run in parallel (this might be useful when cloning/updating a chunk of repos for example)