← 返回笔记列表
Workflow / Terminal

让命令行操作更容易回看

好用的操作记录,应该能解释“为什么执行这一步”,也能说明执行之后该看到什么。

先确认自己在哪里

许多命令都依赖当前目录。执行之前先确认路径和文件列表,是一个成本很低的习惯。在常见的 Unix 风格终端里,可以先查看:

pwd
ls

如果记录要给别人使用,写明从哪个目录开始。不要让读者靠猜测补上操作前提。

先看帮助,再复制参数

同一个工具在不同环境中,选项可能有所不同。先查看本机工具的帮助,核对参数含义,再把它写进自己的记录。--help 是许多工具常用的入口;有些工具使用其他帮助方式。

给一段较长的命令加上简短说明,交代每个重要参数的目的。下一次遇到稍有不同的输入时,才能知道应该修改哪一部分。

一步做一件容易检查的事

准备输入、执行操作、检查输出,分开记录更容易定位问题。不要为了把命令压缩成一行,丢掉了中间状态和检查机会。

  1. 确认输入文件和目标位置。
  2. 执行一个明确的操作。
  3. 查看退出状态和实际输出。
  4. 确认结果之后,再继续下一步。

记录结果,不堆积整个终端

保存关键输出即可。与结论无关的进度条、重复提示和临时路径,会让记录变得难读。能用一句话表达的结果,就不必复制几十行日志。

一条值得留下的命令,最好也带着它的前提和检查方法。