OpenParable
Skip to content
← Back to skills

Shell Style Guide

Development
shell-style-guide

Shell Style Guide is an Agent Skill for development published in the aquasecurity/tracee repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Enforce Tracee shell standards with shellcheck and shfmt. Use when editing shell scripts, YAML run blocks, or shell code blocks in markdown.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/aquasecurity/tracee/blob/HEAD/.cursor/skills/shell-style-guide/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/shell-style-guide, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Shell Style Guide

Quick Start

Apply these requirements for any shell work:

  1. ShellCheck must pass with zero errors.
  2. Format with shfmt based on shell type.
  3. Use braces for variable expansion (${var}).
  4. Keep scripts/lib*.sh POSIX sh compatible.

Commands

  • Bash file:
    • shfmt -i 4 -ci -bn -sr -w <file>
    • shellcheck -s bash <file>
  • POSIX sh file:
    • shfmt -p -i 4 -ci -bn -sr -w <file>
    • shellcheck -s sh <file>
  • Library file:
    • shfmt -p -i 4 -ci -bn -sr -w scripts/lib_example.sh
    • shellcheck -s sh -x scripts/lib_example.sh

Core Rules

  • Use #!/bin/bash for executables unless strict POSIX compatibility is required.
  • Use #!/bin/sh for scripts/lib*.sh.
  • Do not use Bash-only features in POSIX sh (local, arrays, [[ ]], process substitution).
  • Quote expansions and use explicit error handling (set -euo pipefail for Bash, set -eu for POSIX).
  • For POSIX sh helper variables in non-library scripts, use single underscore namespacing.

Detailed Reference

For the complete Tracee shell style details, see reference.md.