1 个不稳定版本
0.1.0 | 2020年3月22日 |
---|
#47 in #zsh
10KB
138 行
ok
这是 ok-bash 的 Rust 分支。
"ok" 为 bash 提供了 .ok 文件夹配置。
ok
使您更聪明、更高效。
您是否在许多不同的项目中工作?在每个项目中,是否都有特定于该项目的命令?您需要一个 .ok
文件。
.ok
文件包含一些实用的单行命令,特定于所在的文件夹。可以使用简单命令查看。可以使用命令 ok <number>
(例如,ok 3
执行第 3 条命令)执行任何命令。
假设您的 .ok
文件包含以下这三行
./build.sh # builds the project
./deploy.sh # deploys the project
./commit_push.sh "$1" # commit with comment, rebase and push
您可以通过 "ok 1
"、"ok 2
" 或 "ok 3 'oops!'
" 分别运行这些命令。
.ok
文件可以作为记录项目工作方式的整洁地方。如果您有很多项目,或者有很多人在同一个项目上工作,这将非常有用。这是一个如此小的文件;它编写得很快,编辑也很容易。
它比普通文档更好:它是可执行的。
如果您运行不带参数的命令 ok
,您将看到列出的文件,每个命令旁边都有编号
$ ok
1. ./build.sh # builds the project
2. ./deploy.sh # deploys the project
3. ./commit_push.sh "$1" # commit with comment, rebase and push
(它还将被格式化得很有风格,以便一目了然地阅读)
然后,如果您运行 ok <number>
(在 ok 后面跟一个数字),您将执行该文件的该行。
$ ok 1
$ ./build.sh # builds the project
building.....
您还可以向命令传递简单的参数。例如
$ ok 3 "Added laser guidance system"
$ ./commit_push.sh "$1" # commit with comment, rebase and push
Committing with comment "Added laser guidance system"
Commit succeeded.
Rebase successful
Pushing to master.
入门
安装
将发布页面 最新版本 的二进制文件放置到您的 PATH
中。
安装后的第一步
您可以尝试使用包含的 .ok
文件,通过导航到 ~/path/to/ok
并输入 ok
来进行测试。探索一些选项。
接下来,您可以创建自己的 .ok
文件。导航到您希望使用 ok
的任何文件夹,例如运行
echo '# My first ok-command'>>.ok
echo 'echo "Hi $USER, the time when pressed enter was $(date "+%H:%M:%S")"'>>.ok
第一行给 .ok
文件添加了“标题”,这对于保持文件组织很有帮助。我使用了追加重定向(>>.ok
)来向 .ok
文件追加一行。如果文件不存在,则会创建它。
此外,我使用了单引号 '
,这样在字符串最终进入你的 .ok
文件之前,就不会发生任何奇怪的事情。这样,$USER
和 $(date...)
在运行 ok
命令时会被评估,而不是在你将行添加到 .ok
文件时。
那么这些 .ok
文件应该放些什么呢?一个好的开始是查看项目的文档:搜索其中所有被埋没的命令。甚至添加一条注释(并在正确的标题下分组)运行脚本文件也可以非常有帮助。每次你使用 man
命令或在网上搜索它时,记得检查是否值得将其添加到你的 .ok
文件中。很可能值得。而且很容易再次删除。
之后你可以看看自定义。这允许你做以下事情
- 每次你更改文件夹时自动显示 ok 列表
- 更改配色方案和其他格式化选项
- 创建使用 ok 的自定义命令
依赖项
~3–11MB
~91K SLoC