findfmt Documentation

findfmt is a high-performance, .gitignore-aware file discovery and classification suite. It locates files by content format, shebang, and MIME tag rather than relying strictly on file extensions.

1. Core Capabilities

• Intelligent Classification: Powered by the identify engine and content heuristics to identify file types (e.g. Python, Shell, YAML, JSON, Executable) even when filenames lack extensions.

• Git-Aware Traversal: Automatically prunes directories and files matched by .gitignore and .git/info/exclude rules early in traversal.

• Deterministic Output: Always produces clean, relative, alphabetically sorted file paths ready for Unix pipelines and xargs.

• Modern Python Architecture: Built with a strict uv-first methodology, 100% test coverage, and strict static type checking.

User Guide

• User Guides
  • Installation
  • Quickstart
  • CI/CD Integration

CLI Reference

• CLI Reference
  • 1. Synopsis
  • 2. Options

API Documentation

• API Reference
  • Package Modules

Quality & Architecture

• Quality Metrics & Architecture

Community & Governance

• Accessibility Statement
• Security Policy

---

2. Community & Feedback

• Source Code: github.com/bdperkin/findfmt

• Issue Tracker: Report bugs, request formats, or propose features on GitHub Issues.

• Contributing: Review the Contributing Guidelines to get started with local development.

• Accessibility: See our Accessibility Statement for supported assistive technologies and barrier reporting.

• Security Policy: See our Security Policy for reporting vulnerabilities and threat modeling details.