Machine Setup

想法是能够在重置您的机器或使用全新的机器时复制特定的设置。此外，在需要时，还应能够轻松更新设置，例如更新您的 vim 配置文件。因此，它将有助于管理 dotfiles、符号链接等。

一个现实世界的示例可以在我的 .dotfiles 仓库 中找到。

您还可以使用它来完成其他任务，例如通过提供安装特定依赖项和检出重要仓库的配置来简化新同事的入职流程。

安装

通过 cargo 安装或从 发布页面 下载二进制文件。

cargo install machine_setup

安装 Shell 完成脚本

zsh

这可能会因您的设置而异。

1. 下载 shell 完成脚本并将它们放入您的 fpath 中的适当文件夹

sudo wget -P /usr/local/share/zsh/site-functions/ https://raw.githubusercontent.com/timopruesse/machine_setup/main/completions/_machine_setup

2. 重新加载 zsh

exec zsh

其他

其他壳（如 fish）的 shell 完成脚本可以在 completions 中找到。
您欢迎使用 PR 为您喜欢的 shell 提供安装说明。😇

运行

子命令

默认情况下，machine_setup 将查找一个名为 machine_setup 的文件，该文件具有支持的文件格式。
支持的文件格式是：yaml、yml 和 json。

命令行参数

支持的配置文件格式

支持的格式有 YAML 和 JSON。

配置

任务可以在 tasks 根键下定义。每个任务可以包含任意数量的命令。

特定任务的配置

TODO: 添加 JSON 示例...

查看下面的示例配置

temp_dir: "~/my_temp" # defaults to "~/.machine_setup"
default_shell: "zsh" # defaults to "bash"
parallel: true
num_threads: 2
tasks:
  my_task1:
    os: ["linux", "windows"]
    parallel: true
    commands:
      - copy:
          src: "./src/files"
          target: "/tmp/target"
      - copy:
          src: "./src/files_2"
          target: "/tmp/target"

  my_task2:
    os: ["linux"]
    parallel: true
    commands:
      - shell: "sudo apt-get install git -y"
      - symlink:
          src: "./src/config"
          target: "~/.dotfiles"

扩展配置

可扩展性不是显式构建的。
然而，可以通过 machine_setup 命令从另一个配置中执行任务。

可用的配置命令

copy

此命令将目录内容复制到另一个目录。

示例

copy:
  src: "./src/files"
  target: "/tmp/target"
  ignore: ["dist", "package-lock.json"]

clone

此命令将 git 仓库克隆到指定的目标位置。

示例

clone:
  url: "[email protected]:timopruesse/machine_setup.git"
  target: "~/machine_setup"

symlink

此命令将源目录中的所有文件符号链接到目标目录。

如果 force 设置为 true，则现有的文件将被 删除 并用符号链接替换。

示例

symlink:
  src: "./src/files"
  target: "/tmp/target"
  ignore: ["dist", "package-lock.json"]
  force: true

run

此命令执行 shell 命令。

提示：尽可能避免使用交互式命令。

默认情况下，在更新或卸载时将跳过 shell 命令。您可以通过提供 update 和/或 uninstall 来更改此设置。

可以将以下参数传递给 commands

示例

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"
        - ...

machine_setup

使用此命令可以包含其他 machine_setup 配置文件。

示例

machine_setup:
  config: "./my_other_config.yaml"
  task: "my_other_task" # optional