bash-style

Enforce Bash scripting conventions across shell scripts, Dockerfiles, Makefiles, and Markdown YAML blocks.

1.0k|102|Updated Jan 4, 2026
One-click install
npx skills add https://github.com/doccker/cc-use-exp --skill bash-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bash-style
Source: https://github.com/doccker/cc-use-exp/tree/main/.claude/skills/bash-style
Command: npx skills add https://github.com/doccker/cc-use-exp --skill bash-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enforces Bash scripting conventions to improve readability and reduce errors across shell scripts (.sh), Dockerfiles, Makefiles, and YAML blocks within Markdown.

Core Features & Use Cases

  • Enforces that comments are placed on their own lines rather than inline trailing comments.
  • Guides proper quoting, heredoc usage, and safe scripting practices.
  • Use Case: a team standardizes shell code across CI pipelines and documentation, ensuring consistent style and reliable execution.

Quick Start

Apply the bash-style guidelines to your repository by running a style check on a sample shell script and updating comments to the recommended format.

Frequently Asked Questions about bash-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce Bash coding standards for clean shell scripts?

To enforce Bash coding standards for clean shell scripts, apply rules that ban trailing inline comments and mandate line comments above code. This improves readability and ensures safe quoting and heredoc practices across your codebase.

Can I apply shell script style rules to Dockerfiles and Makefiles?

Yes, you can apply shell script style rules to Dockerfiles and Makefiles. The conventions extend beyond .sh files to govern quoting, heredoc usage, and comment placement within these formats for consistent execution.

Why should I use line comments instead of trailing inline comments in Bash?

You should use line comments instead of trailing inline comments in Bash to improve readability and reduce errors. Placing comments on their own lines above the code ensures clearer scripting conventions for development and code review.

What is the best way to standardize shell code across CI pipelines?

The best way to standardize shell code across CI pipelines is to enforce consistent style guidelines for quoting, heredoc usage, and comment placement. This ensures reliable execution and prevents syntax errors during automated builds.

Does this Bash style guide check YAML blocks within Markdown files?

Yes, this Bash style guide does check YAML blocks within Markdown files. It enforces safe scripting practices and comment conventions within embedded YAML blocks to maintain documentation consistency alongside your shell scripts.