shell-review

审计Shell脚本的正确性、可移植性和常见陷阱

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:shell-review。
它的用途是:审计Shell脚本的正确性、可移植性和常见陷阱
完整的 Skill 内容见:https://321skill.com/skills/shell-review-x-7/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

'我对这个部署脚本不太放心,帮我用shell-review扫描一下,看看有没有可移植性问题或常见陷阱。' 它会自动调用 shell-review 对脚本进行静态审计,返回包含行号、问题类型和修复建议的详细报告,例如提示“未引用变量”或“缺少 set -e 导致错误传播”。

介绍

Shell脚本在开发、运维和部署中无处不在,但语法错误、跨平台兼容性问题以及常见陷阱常常导致运行时故障。shell-review 是一款针对 Shell 脚本的静态审计工具,能够自动检查脚本中的语法错误、可移植性缺陷(如依赖特定 bash 特性)以及常见陷阱(如未引用变量、竞态条件、错误处理缺失等),帮助开发者和运维人员在脚本上线前发现潜在风险。

使用非常简单:安装后只需在终端中执行 shell-review <脚本文件> 或通过管道将脚本内容传入,即可获得结构化的审计报告。报告会按问题类型分类,并给出具体行号、问题描述和修复建议。该工具支持常用的 Shell 方言(bash、sh、dash 等),并允许通过配置文件自定义规则。

适合所有编写或维护 Shell 脚本的开发者、运维工程师和测试工程师。无论是日常运维脚本、CI/CD 流程中的构建脚本,还是部署到多平台环境的自动化脚本,都可以在提交前用 shell-review 快速过一遍,避免因小问题导致线上故障。

建议在持续集成流程中集成 shell-review,作为代码质量门禁的一环。同时注意,它专注于静态审计,不涉及脚本运行时的性能分析或动态行为验证。对于复杂逻辑或多步骤编排,建议配合实际测试环境使用。

核心特点

与 ShellCheck 等传统语法检查工具相比,shell-review 不仅检测语法错误,还专门针对跨平台可移植性(如 POSIX 兼容性)和常见陷阱(如未设置 set -e 导致错误忽略)提供深度审计,报告更贴近实际部署场景。

注意事项

不适合对脚本运行时性能进行优化分析,也不适用于动态语言或非 Shell 脚本的代码审计。

常见问题

如何安装 shell-review?

通常通过 npm 全局安装:npm install -g shell-review,或者使用 npx shell-review 直接运行。

支持哪些 Shell 版本?

支持 bash、sh、dash、zsh 等常见 Shell 方言,可通过参数指定目标 Shell 类型。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/shell-review-x-7/raw/index.md 读取 shell-review 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。