Cheatshfmt Shell script formatter
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
shfmt script.shPrint formatted script
shfmt -d .Show diffs, fail if any
shfmt -l .List unformatted files
shfmt -w script.sh
Format in place
shfmt -l -w .Fix a whole tree
shfmt -i 2 -ci2 spaces, indent cases
cat script.sh | shfmt
Format stdin
shfmt -f .Find shell files
Concepts
- Script *.sh or shebang
- Syntax tree dialect rules
- Formatted code flags / .editorconfig
- Result file, diff or list
Run
shfmt <file>
Print the formatted script
shfmt -w <file>
Write the result back to the file
shfmt -d <path>
Show a diff, exit non-zero if different
The CI-friendly check. Color is off with NO_COLOR or
TERM=dumb.
shfmt -l <path>
List files whose formatting differs
shfmt -l -w .Format everything under here
A directory path walks it and picks up shell scripts only.
shfmt -Read from stdin
Without arguments on a terminal it prints usage instead of
waiting.
shfmt -l=0 <path>
List files separated by NUL
shfmt --versionShow version
Style (printer)
shfmt -i <n>
Indent with n spaces (0 = tabs)
Tabs are the default.
shfmt -ciIndent case branches
shfmt -bn
Binary ops like && and | may start a line
shfmt -srSpace after redirect operators
shfmt -bl
Opening brace, then and do on their own line
shfmt -kpKeep column alignment padding
Deprecated; slated for removal.
shfmt -mnMinify the script
Implies -s.
shfmt -i 2 -ci -bn
Roughly Google's shell style
Dialect and parsing
shfmt -ln <dialect>
Set dialect: bash, posix, mksh, bats, zsh
Default is auto: from file extension, then shebang, then bash.
shfmt -pShorthand for -ln=posix
A .sh extension alone implies posix unless the shebang says
otherwise.
shfmt -sSimplify code where safe
shfmt --filename <name>
Name for stdin input
Needed for EditorConfig and dialect detection when reading
stdin.
shfmt --detect <mode>
How to find files: default, exec or all
shfmt --apply-ignore
Always honor EditorConfig ignore rules
shfmt -f <path>
Print shell files found, no formatting
shfmt --to-jsonPrint the syntax tree as JSON
Config (.editorconfig)
[*.sh]indent_style = spaceindent_size = 2case_indent = truebinary_next_line = truespace_redirects = truelanguage_dialect = bashindent_style / indent_size
Same as -i
case_indent, binary_next_line
Same as -ci and -bn
[[shell]] section header
Match scripts by shebang, no extension
Outside the EditorConfig spec and may change.
ignore = trueSkip a path when walking directories
Recipes
# fails the job when anything differsshfmt -d -i 2 -ci .git ls-files -z '*.sh' | xargs -0 shfmt -wshfmt -ln posix script.sh >/dev/null# prints line:col and error if invalid# .pre-commit-config.yaml- repo: https://github.com/scop/pre-commit-shfmt rev: v3.14.1-1 hooks: - id: shfmt
