Archie

Archie 是一个命令行工具，帮助根据模板构建文件夹结构。您可以通过以下方式之一提供基于配置文件的模板，按优先级排序：

1. --config <路径/到/文件>选项
2. .archierc.yaml文件在当前目录
3. archie.yaml在全局配置目录
   • $XDG_CONFIG_HOME/archie或$HOME/.config/archie在 Linux 上
   • %USERPROFILE%\AppData\Roaming\archie在 Windows 上
   • $HOME/Library/Application Support/archie在 macOS 上

安装

Homebrew

您可以通过Homebrew安装 Archie，只需添加我的 tap

brew tap essay97/harrysthings
brew update
brew install archie

Cargo

如果您是 Rust 用户并且熟悉这些工具，您可以直接使用cargo从crates.io安装 Archie

cargo install archie

配置

无论您选择哪种方法传递配置文件，格式始终相同：一个包含单个根对象templates的 YAML 文件。

您通过向templates对象添加键来定义一个新模板。一个模板可以包含两种类型的节点：

• 一个 文件夹 节点：名称以/结尾
• 一个 文件 节点：没有尾部/

通过组合和嵌套这两种类型的节点来塑造您的模板。

示例

假设我想定义一个名为“example”的模板

templates:
  example:            # creates the "example" template
    foo/:             # creates the "foo" folder
      hello.txt:      # creates the "hello.txt"
      my_folder/:     # creates the empty folder "my_folder"
    bar/:             # creates the "bar" folder at the same level of "foo"
    file:             # creates the "file" file at the same level of "foo" and "bar"

请注意，Archie 只考虑配置文件的键，所以即使文件必须是对象，也可以没有主体（即带有 null 主体）。

一般来说，您想将其转换为文件或文件夹的每个 YAML 元素后面都必须跟着一个冒号。

使用方法

您应该从 archie help 开始，以了解该工具的功能概述。它执行以下简单操作：

• archie build <path> <template> 在给定的 path 中创建由 template 定义的文件夹结构
• archie list 显示基于提供的配置文件可用的模板
• archie info <template> 显示由给定的 template 创建的结构。可以将其视为一种“试运行”

示例

基于前一部分定义的配置文件

> archie list
example
> archie info example
example
├── bar
├── foo
│   ├── hello.txt
│   └── my_folder
└── file
> archie build . example 
## Creates example template in current directory