#script #tree #command #keeper #directory #orun

bin+lib otkeep

用于管理树外脚本的命令行工具

1 个不稳定版本

0.1.0 2022年6月13日

#2070 in 数据库接口

MIT/Apache

30KB
724

OtKeep - 树外守护者

OtKeep 是一个帮助您管理不同项目树外脚本的工具。

它解决了什么问题?

OtKeep 将所有树外脚本存储在其数据库中,让您可以方便地使用它们,就像它们在树内一样。

什么是树外脚本?它们是为项目制作的个人脚本,您不希望将其提交。以下是一些示例

  • 以非常具体的配置运行项目

    设置不同的参数、环境变量等。您想将这些放入脚本中,以便每次不必记住并输入所有这些内容。

  • 以非常具体的配置构建项目

    例如,使用 i686-pc-windows-gnu 交叉编译器调用 cmake,同时交叉编译所有依赖项,并将系统上所有交叉编译的库指向它们。

  • 为您的朋友打包项目以供试用

    这可能涉及将它们编译到他们的操作系统,复制 .dll 文件和资源,然后将其全部压缩

  • 等等。

    我确信您可以想出更多的用例。我经常使用它们来方便个人。我不是在这里推销树外脚本的想法,而是在这里推销管理这些脚本的工具的想法。

您不想将这些类型的脚本提交到存储库中,因为它们非常特定于您。

关于只是将它们添加到 .gitignore 或类似文件中呢?这样做的问题是它们很容易被 git clean -dfx 或存储库的重新克隆所破坏。而且它们仍然会弄脏工作树。它们组织得不好。

将它们存储在用户目录中的某个数据库中不是更好吗?这正是 OtKeep 的用途。

不用说,如果您不需要处理树外脚本,那么 OtKeep 就不适合您。

用法

OTKeep 提供 2 个工具,用于管理您的脚本:okeep,用于运行它们:orun

添加脚本

要添加脚本,请使用 okeep add。例如,要将名为 build_win.sh 的 Windows 交叉构建脚本添加,请执行 okeep add build-win build_win.sh

运行脚本

要运行您添加的脚本,请位于您添加脚本所在的树中,然后只需以脚本名称作为参数运行 orun 即可。对于前面提到的 build-win 例子,您将运行 orun build-winorun 将将所有参数转发给脚本。

列出当前树的脚本

只需运行不带任何参数的 orun。它将列出当前树中可用的脚本。

依赖项

~24MB
~462K SLoC