bash-style skill
Enforces coding standards for Bash scripts, Dockerfiles, Makefiles, and YAML files to ensure readability and security.
- GitHub 스타
- 1,061
- 파일
- 1
- 마지막 커밋
- 2026년 8월 26일
- 라이선스
- —
- 허용된 도구
- —
bash-style skill은 무엇을 하나요?
Enforces coding standards for Bash scripts, Dockerfiles, Makefiles, and YAML files to ensure readability and security.
skill의 SKILL.md에서 생성된 요약입니다.
bash-style skill 설치 방법
각 명령은 skill 폴더를 클라이언트의 skills 디렉터리에 복사합니다. 클라이언트를 재시작하거나 새 세션을 시작하여 로드하세요.플러그인에 bash-style skill 설치
/plugin marketplace add doccker/cc-use-exp /plugin install cc-use-exp@cc-use-exp
Claude Code에 bash-style skill 설치
~/.claude/skills/bash-style/SKILL.md
$ npx degit doccker/cc-use-exp/skills/bash-style ~/.claude/skills/bash-styleClaude Code (project)에 bash-style skill 설치
.claude/skills/bash-style/SKILL.md
$ npx degit doccker/cc-use-exp/skills/bash-style .claude/skills/bash-styleCodex에 bash-style skill 설치
~/.agents/skills/bash-style/SKILL.md
$ npx degit doccker/cc-use-exp/skills/bash-style ~/.agents/skills/bash-styleGemini CLI에 bash-style skill 설치
~/.gemini/skills/bash-style/SKILL.md
$ npx degit doccker/cc-use-exp/skills/bash-style ~/.gemini/skills/bash-styleClaude.ai에 bash-style skill 설치
npx degit doccker/cc-use-exp/skills/bash-style bash-style && zip -r bash-style.zip bash-style # claude.ai → Customize → Skills → + → Create skill → Upload a skill → bash-style.zip
자동 검사
2026년 11월 15일에 실행됨전체 보고서 →아직 검증되지 않았습니다. 스킬은 점수 80, 심각한 발견 없음, 검사에 충분한 데이터가 필요합니다. 검사 방식 · 점수를 높이기 위해 수정할 항목
- 소스 저장소 연결 및 접근 가능doccker/cc-use-exp/skills/bash-style is public and reachablegithub.com/doccker/cc-use-exp/tree/HEAD/skills/bash-style ↗통과
- 오픈 소스 라이선스 (OSI)No license결함 발견
- 최근 1년 내 커밋 또는 릴리스Last commit 2026-08-26github.com/doccker/cc-use-exp/commits ↗통과
- 스크립트에 다운로드 후 실행이나 자격 증명 탈취가 없음No scripts in the skill folder통과
- SKILL.md에 숨겨진 지침 없음No override phrases, safeguard switches, credential requests or hidden charactersgithub.com/doccker/cc-use-exp/blob/HEAD/skills/bash-style/SK ↗통과
- 사전 허용 도구가 제한됨No pre-approved tools; the agent asks before using onegithub.com/doccker/cc-use-exp/blob/HEAD/skills/bash-style/SK ↗통과
- SKILL.md가 Agent Skills 형식을 따름the description does not say when to use the skillgithub.com/doccker/cc-use-exp/blob/HEAD/skills/bash-style/SK ↗결함 발견
SKILL.md
GitHub에서 보기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
```
参考资料
이 스킬의 파일
1bash-style skill 질문
Claude Code에 bash-style skill을 어떻게 설치하나요?
npx degit doccker/cc-use-exp/skills/bash-style ~/.claude/skills/bash-style를 실행합니다. Claude Code는 ~/.claude/skills(모든 프로젝트) 또는 .claude/skills(한 프로젝트)에서 skills를 로드하며, 설명이 작업과 일치할 때 skill을 사용합니다.
bash-style skill을 사용할 수 있는 클라이언트는 무엇인가요?
Agent Skills 형식을 읽는 모든 클라이언트(Claude Code, Codex, Gemini CLI, claude.ai(ZIP으로 업로드))가 사용할 수 있습니다. skill 내 스크립트는 클라이언트가 코드 실행을 허용하는 경우에만 실행됩니다.
How should comments be placed in Bash scripts?
Comments should be placed on their own line above the code rather than at the end of a command.
How can I prevent variable expansion when using Heredoc?
Wrap the EOF delimiter in single quotes to output the content exactly as written without parsing variables.
What is the recommended way to write files with sudo?
Use the tee command with sudo to avoid the complexity and errors associated with nested quotes.