mcpField
S
shell

shell

github.com/pproenca开发218695 次安装11 周前更新
代码仓库

关于 shell

面向 AI Agent 和 LLM 的 Shell 脚本实践指南,按影响优先级组织 49 条规则,并配有说明和正误示例,涵盖安全、可移植性与性能。

主要功能

  1. 01涵盖 9 类脚本主题
  2. 02提供 49 条优先级规则
  3. 03包含错误与正确示例
  4. 04涵盖安全性和可移植性
  5. 05提供错误处理与性能建议

适用场景

  1. 01编写 Bash 或 POSIX Shell 脚本
  2. 02审查脚本安全风险
  3. 03排查脚本静默失败
  4. 04将脚本移植至不同环境

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/pproenca/dot-skills --skill shell

安装后在 Claude Code 中输入/shell确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

AGENTS.md
metadata.json
README.md
assets/templates/
_template.md
references/
_sections.md
err-check-commands.md
err-debug-tracing.md
err-exit-codes.md
err-pipefail.md
err-shellcheck.md
err-stderr-messages.md
err-strict-mode.md
err-trap-cleanup.md
func-avoid-aliases.md
func-documentation.md
func-main-pattern.md
func-return-values.md
func-single-purpose.md
perf-avoid-subshells.md
perf-batch-operations.md
perf-builtins-over-external.md
perf-parameter-expansion.md
perf-process-substitution.md
perf-read-files.md
port-avoid-bashisms.md
port-export-syntax.md
port-printf-over-echo.md
port-shebang-selection.md
port-test-portability.md
quote-always-quote-variables.md

详细介绍

Shell 脚本最佳实践(社区)

面向 AI Agent 和大模型的 Shell 脚本最佳实践综合指南。包含 9 个类别中的 49 条规则,按影响程度排序,从关键(安全性、可移植性)到渐进改进(风格)。每条规则都包含详细说明、对比错误与正确实现的真实示例,以及具体的影响指标。

适用场景

遇到以下情况时,请参考这些指南:

  • 编写新的 bash 或 POSIX shell 脚本
  • 检查 shell 脚本中的安全漏洞
  • 调试静默失败或行为异常的脚本
  • 在 Linux、macOS 和容器之间移植脚本
  • 优化 shell 脚本性能
  • 使用 shell 脚本设置 CI/CD 流水线

按优先级划分的规则类别

优先级类别影响前缀规则数
1安全与防护严重safety-6
2可移植性严重port-5
3错误处理高err-8
4变量与数据高var-5
5引号与展开中高quote-6
6函数与结构中func-5
7测试与条件语句中test-5
8性能低至中perf-6
9风格与格式低style-3

快速参考

1. 安全与防护(严重)
2. 可移植性(严重)
3. 错误处理(高)
4. 变量与数据(高)
5. 引用与展开(中高)
6. 函数与结构(中)
7. 测试与条件判断(中)
8. 性能(低至中)
9. 风格与格式(低)

使用方法

阅读各个参考文件,了解详细说明和代码示例:

参考文件

文件说明
AGENTS.md包含所有规则的完整汇编指南
references/_sections.md类别定义与排序
assets/templates/_template.md新规则模板
metadata.json版本与参考信息

主要来源

评论

支持 Markdown