命令行工具不仅面向人在终端中阅读,也经常成为自动化流程的一部分。输出格式和退出码因此属于公开接口。
区分输出通道
正常结果写入标准输出,诊断和进度写入标准错误。这样调用者可以安全地把结果传递给下一个命令。
提供机器格式
表格适合人阅读,JSON 更适合程序消费。字段名称应保持稳定,新增字段通常比修改现有语义更安全。
明确退出码
成功返回零,可预期的未找到、参数错误和远端失败应返回非零。不要用成功退出配合错误文本让脚本自行猜测。
命令行工具不仅面向人在终端中阅读,也经常成为自动化流程的一部分。输出格式和退出码因此属于公开接口。
正常结果写入标准输出,诊断和进度写入标准错误。这样调用者可以安全地把结果传递给下一个命令。
表格适合人阅读,JSON 更适合程序消费。字段名称应保持稳定,新增字段通常比修改现有语义更安全。
成功返回零,可预期的未找到、参数错误和远端失败应返回非零。不要用成功退出配合错误文本让脚本自行猜测。