ReddRadar
Agent skill
bash-style
当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件，或在 Markdown 中编写 bash 代码块时触发。提供 Bash 编写规范。
Install this agent skill to your Project
npx add-skill https://github.com/doccker/cc-use-exp/tree/main/.claude/skills/bash-style
SKILL.md
Bash 编写规范
版本：v1.0 更新：2026-01
1. 注释规范
禁止行尾注释
- ❌ 禁止行尾注释（如
command # 注释） - ✅ 注释应独占一行，放在代码上方
适用范围：
- Shell 脚本文件（.sh）
- Markdown 文档中的 bash 代码块
- Dockerfile、Makefile 中的 shell 命令
# ❌ 错误：行尾注释
curl -X POST https://api.example.com/data # 发送请求
docker run -d nginx # 启动容器
cp -r src/ dist/ # 复制文件
# ✅ 正确：注释独占一行
# 发送请求
curl -X POST https://api.example.com/data
# 启动容器
docker run -d nginx
# 复制文件
cp -r src/ dist/
原因：
- 复制粘贴时容易带上注释导致命令出错
- 长命令 + 注释 = 超长行，可读性差
- Heredoc 块内
#不是注释而是内容
2. 文件写入方式
推荐方式：tee 命令
# ✅ 推荐：简洁、无嵌套引号
sudo tee /etc/fail2ban/jail.d/docker-nginx.local > /dev/null << 'EOF'
[docker-nginx]
enabled = true
filter = docker-nginx
logpath = /var/log/nginx/access.log
maxretry = 5
EOF
追加内容
# ✅ 追加到文件
sudo tee -a /etc/hosts > /dev/null << 'EOF'
192.168.1.100 myserver
EOF
# ✅ 单行追加
echo '192.168.1.100 myserver' | sudo tee -a /etc/hosts
避免的写法
# ❌ 避免：嵌套引号复杂，易出错
sudo bash -c 'cat > /etc/xxx << EOF
content
EOF'
# ❌ 避免：需要转义内容中的特殊字符
sudo sh -c "echo 'line1\nline2' > /etc/xxx"
方式对比
| 方式 | 优点 | 缺点 | 推荐场景 |
|---|---|---|---|
sudo tee |
简洁、无嵌套 | 需 > /dev/null 抑制输出 |
首选 |
sudo bash -c 'cat >' |
无需 tee | 嵌套引号复杂 | 不推荐 |
| 临时文件 + mv | 可先验证 | 步骤多 | 复杂配置 |
3. Heredoc 引号规则
禁止变量展开（推荐默认）
# ✅ 'EOF' 带引号：内容原样输出，不解析变量
sudo tee /etc/xxx > /dev/null << 'EOF'
$HOME 不会被展开
$(command) 不会被执行
EOF
需要变量展开
# EOF 不带引号：变量会被展开
sudo tee /etc/xxx > /dev/null << EOF
当前用户: $USER
当前目录: $(pwd)
EOF
选择原则
| 场景 | 用法 | 原因 |
|---|---|---|
| 配置文件 | << 'EOF' |
避免意外展开 |
| 模板生成 | << EOF |
需要插入变量 |
| 不确定时 | << 'EOF' |
更安全 |
4. 权限与路径
需要 root 权限
# ✅ 正确：tee 配合 sudo
echo 'content' | sudo tee /etc/xxx
# ❌ 错误：重定向在 sudo 之外，权限不足
sudo echo 'content' > /etc/xxx
路径带空格
# ✅ 正确：双引号包裹路径
sudo tee "/etc/my config/file.conf" > /dev/null << 'EOF'
content
EOF
5. 脚本规范
文件头
#!/usr/bin/env bash
set -euo pipefail
# 脚本说明（一句话）
set 选项说明
| 选项 | 作用 |
|---|---|
-e |
命令失败时退出 |
-u |
使用未定义变量时报错 |
-o pipefail |
管道中任一命令失败则整体失败 |
变量使用
# ✅ 推荐：使用 ${} 包裹
echo "Hello, ${name}"
# ✅ 推荐：设置默认值
db_host="${DB_HOST:-localhost}"
# ❌ 避免：裸变量（易与后续字符混淆）
echo "Hello, $name_suffix"
6. 常用模式
检查命令是否存在
if ! command -v docker &> /dev/null; then
echo "docker 未安装"
exit 1
fi
检查文件/目录
# 文件存在
[[ -f /path/to/file ]] && echo "文件存在"
# 目录存在
[[ -d /path/to/dir ]] || mkdir -p /path/to/dir
安全删除
# ✅ 使用变量时防止误删
rm -rf "${dir:?}"/*
# ❌ 危险：变量为空时会删除根目录
rm -rf $dir/*
7. 文档中的代码块
在 Markdown 文档中编写 bash 命令时，同样遵循以上规范：
## 安装配置
创建配置文件：
```bash
sudo tee /etc/myapp/config.yml > /dev/null << 'EOF'
server:
port: 8080
host: 0.0.0.0
EOF
```
参考资料
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
doccker/cc-use-exp
ops-safety
运维安全规范。当用户执行系统级命令（sysctl、iptables、systemctl、Docker 配置、数据库 DDL） 或进行服务器运维操作时触发。 包含命令风险说明模板、回滚方案要求、问题排查原则、Docker/Cloudflare/数据库场景规则等。
doccker/cc-use-exp
ruanzhu
当用户执行 /ruanzhu 命令或请求生成软著源代码文档时触发。提供软著源代码 DOCX 生成规范。 覆盖项目信息检测、语言扫描规则、页数控制、DOCX 格式规范等。
doccker/cc-use-exp
ui-ux-pro-max
专业级 UI/UX 设计规范，需要高质量界面设计时手动触发或描述"设计感/专业UI"时自动触发。 覆盖视觉层次、配色体系、排版节奏、交互微动效、响应式适配等。 日常前端开发由 frontend-dev skill 覆盖。
doccker/cc-use-exp
bash-style
Bash 编写规范。当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件， 或在 Markdown 中编写 bash/shell 代码块时触发。 包含注释规范、文件写入方式、Heredoc 引号规则、权限路径、脚本规范等。
doccker/cc-use-exp
redis-safety
Redis 安全与性能规范。当用户操作 Redis 相关代码（go-redis、Jedis、redis-py、ioredis）时触发。 包含禁止 KEYS 命令、SCAN 替代、大 key 控制、Pipeline 批量、TTL 规范等。
doccker/cc-use-exp
python-dev
Python 开发规范。当用户操作 .py、pyproject.toml、requirements.txt、setup.py 文件， 或涉及 FastAPI、Django、Flask、pytest、asyncio 开发时触发。 包含 PEP 8 风格、类型注解、异常处理、测试规范、异步编程、性能优化等。
Didn't find tool you were looking for?