unfk 1.3.2

UNiversal File... Korrector?

A fast CLI tool for scanning and repairing file formatting issues in a broad variety of file types.

Overview

unfk detects and fixes common file formatting inconsistencies:

• Line endings — mixed or incorrect line endings (LF vs CRLF)
• Indentation — inconsistent tabs/spaces or wrong indent width
• Encoding — non-UTF-8 files or encoding mismatches
• Final newlines — missing or extra newlines at end of file
• Trailing whitespace — spaces/tabs at end of lines
• Blank lines (Markdown) — multiple successive blank lines in .md files

Unlike code formatters such as Prettier or Black, unfk is not concerned with code style or syntax. Instead, it focuses on general formatting and file hygiene issues that affect a much broader range of file types — config files, scripts, data files, documentation, and more.

unfk is aware of file type-specific conventions and applies the right defaults automatically. For example:

• .go files use tabs by convention, while .py and .rs use 4 spaces and .rb uses 2, etc.
• Makefile requires tabs for indentation
• .vb and .reg files require CRLF line-endings
• Windows batch files (.bat, .cmd) and PowerShell scripts (.ps1) require CRLF line endings

This means you can run unfk fix across a mixed codebase and trust it to do the right thing for each file type.

Example:

# Scan and optionally fix files recursively
unfk

# Scan a file or directory
unfk scan document.md

# Fix all issues
unfk fix --all document.md

unfk is written in Rust and runs on macOS, Linux and Windows (Intel, ARM and Apple Silicon).

Installation and Update

There are many ways to install unfk depending on your platform.

macOS (Homebrew)

brew tap keathmilligan/tap
brew install keathmilligan/tap/unfk

Stay up-to-date with brew upgrade unfk.

See the macOS Install Guide for other ways to install on macOS.

Windows (PowerShell)

In an elevated powershell session, run:

irm https://packages.keathmilligan.net/unfk/install.ps1 | iex

See the Windows Install Guide for other ways to install on Windows.

Linux (shell installer)

curl -fsSL https://packages.keathmilligan.net/unfk/install.sh | sh

This will install unfk into ~/.local/bin.

See the Linux Install Guide for other ways to install on Linux.

Quick Start

# Scan current directory and optionally fix issues
unfk

# Scan a file or directory
unfk scan docs

# Fix all issues
unfk fix

# Preview changes without modifying files
unfk fix --dry-run

# Create a configuration file
unfk init

Commands

Configuration

A config file is not required — unfk assumes sane defaults for most file types and modern development conventions.

EditorConfig Support

unfk automatically reads .editorconfig files if present. This lets you share formatting settings across tools and editors without duplicating configuration. The following EditorConfig properties are supported:

Precedence order: CLI flags > .unfkrc.toml > .editorconfig > built-in defaults

To disable EditorConfig integration, use --no-editorconfig.

Custom Configuration

For custom rules, create .unfkrc.toml in your project root:

line-ending = "lf"
encoding = "utf-8"
final-newline = true
trailing-whitespace = "remove"

[indent]
style = "spaces"
width = 2

# Per-pattern overrides
[[rules]]
pattern = "*.py"
[rules.indent]
style = "spaces"
width = 4

Replacing Legacy Tools

unfk can replace several single-purpose legacy utilities with one modern, file-type-aware tool:

# Convert all files to LF (respecting file-type conventions)
unfk fix --line-ending lf

# Convert specific files to CRLF
unfk fix --line-ending crlf src/scripts/*.bat

# Preview what would change
unfk fix --line-ending lf --dry-run

License

MIT