sakura

中文文档 | English

一个用于初始化 Git Worktree 的交互式 Node.js 命令行工具。

sakura 可以极大地简化创建和管理 Git Worktree 的流程。它能够自动从你的剪贴板中解析 git clone 命令，通过交互式菜单引导你输入任务信息，并高效地为你搭建好对应的代码工作区。

功能特性

• 交互式界面 (UI): 使用方向键直观地选择工作区位置和任务类型。
• 剪贴板集成: 自动读取剪贴板中的 git clone 命令，无需手动粘贴。
• Git Worktree 自动化: 自动拉取远程最新代码，并无缝挂载新的 Worktree 分支。
• Maven 支持: 自动扫描克隆下来的 Maven 项目，并为你生成聚合的 pom.xml。
• IntelliJ IDEA 集成: 环境准备就绪后，自动唤起 IDEA 并打开新的工作区。

配置 (Configuration)

第一次运行 sakura 时，如果没有检测到配置文件，工具会通过交互式命令行引导你完成首次配置（输入工作区名称和目录）。配置内容会自动保存在 ~/.config/sakura/config.json 中。你后续可以通过修改该文件来添加更多的目标工作区选项。

配置示例：

{
    "workspaces": [
        {
            "name": "Banksteel",
            "value": "banksteel",
            "workspaceDir": "~/Public/banksteel/code",
            "baseReposDir": "~/Public/banksteel/base_repos"
        }
    ],
    "defaultWorkspace": "banksteel"
}

管理配置： 你也可以随时在终端中运行配置向导来增加工作区或编辑配置：

sakura config

安装

你可以通过 NPM 全局安装该工具：

npm install -g sakura-cmd

(如果你想进行本地开发，可以克隆本仓库并在根目录下运行 npm link)

使用方法

1. 复制一个或多个 git clone 命令到你的剪贴板。 例如：

   git clone -b feat/my-branch https://github.com/my-org/my-repo.git

2. 在终端中运行 sakura 命令：

   sakura

3. 按照终端内的交互提示，选择你的工作区位置和任务类型即可。

追加项目到现有工作区： 如果你想为一个已经在开发中的需求追加一个新的项目，有两种方式：

1. 常规方式：复制新项目的 git clone，运行 sakura，在交互界面输入一模一样的任务类型和分支名。工具会自动把新项目放入现有目录，并更新 IntelliJ IDEA 的 pom.xml。
2. 快捷方式：在终端里直接进入该需求的目录（例如 cd ~/Public/banksteel/code/feat/1234_login），然后运行：

   sakura add

   工具会自动识别当前所在的工作区，并跳过交互式问询，极速追加项目！

开源协议

MIT