SuperAPI AI 工具集

shell

编程与开发

查看项目

更新于 10-15 15:26

技能介绍

用途

Shell 脚本最佳实践(社区版)是一份面向 AI 智能体与 LLM 的综合性 shell 脚本编写指南,旨在帮助编写、审查和重构安全、可移植且可维护的 bash/sh 脚本。

主要能力

该指南包含 49 条规则,分布在 9 个类别中,按影响程度从关键(安全、可移植性)到渐进(风格)排序。每条规则均包含详细解释、对比错误与正确实现的真实示例,以及具体的影响指标。

规则类别与优先级

  1. 安全与安全(CRITICAL):6 条规则,前缀 safety-,包括防止命令注入、避免 eval、使用绝对路径、创建安全临时文件、禁止 SUID/SGID、防止参数注入。
  2. 可移植性(CRITICAL):5 条规则,前缀 port-,包括 shebang 选择、避免 bashisms、使用 printf 替代 echo、可移植 export 语法、可移植 test 构造。
  3. 错误处理(HIGH):8 条规则,前缀 err-,包括严格模式、有意义的退出码、trap 清理、错误消息发送到 stderr、pipefail、显式检查命令成功、ShellCheck 静态分析、调试追踪。
  4. 变量与数据(HIGH):5 条规则,前缀 var-,包括使用数组、local 作用域、命名约定、readonly 常量、参数扩展默认值。
  5. 引用与扩展(MEDIUM-HIGH):6 条规则,前缀 quote-,包括始终引用变量扩展、使用 "$@"、引用命令替换、使用花括号、here documents、控制 glob 扩展。
  6. 函数与结构(MEDIUM):5 条规则,前缀 func-,包括 main() 模式、单一职责函数、正确使用返回值、函数文档注释、优先使用函数而非别名。
  7. 测试与条件(MEDIUM):5 条规则,前缀 test-,包括 bash 中使用 [[ ]]、算术比较使用 (( ))、显式空/非空字符串测试、正确的文件测试操作符、case 模式匹配。
  8. 性能(LOW-MEDIUM):6 条规则,前缀 perf-,包括优先使用内置命令、避免不必要的子 shell、进程替换、高效读取文件、参数扩展字符串操作、批量操作。
  9. 风格与格式(LOW):3 条规则,前缀 style-,包括一致缩进、一致文件结构、有用注释。

使用方式

在以下场景中参考这些指南:编写新的 bash 或 POSIX shell 脚本;审查 shell 脚本的安全漏洞;调试静默失败或行为异常的脚本;在 Linux、macOS 和容器之间移植脚本;优化 shell 脚本性能;使用 shell 脚本搭建 CI/CD 流水线。

可阅读各个参考文件获取详细解释和代码示例,包括:章节定义(类别结构与影响级别)、规则模板(添加新规则的模板)。参考文件包括 AGENTS.md(包含所有规则的完整编译指南)、references/_sections.md(类别定义与排序)、assets/templates/_template.md(新规则模板)、metadata.json(版本与参考信息)。

适用场景

适用于 shell 脚本的编写、审查、重构、调试、跨平台移植、性能优化以及 CI/CD 流水线搭建等场景。

限制

该资料未提供具体的安装命令、收费信息、价格、平台支持细节或实际使用效果数据,这些内容暂未提供。