Sawmill

A plugin-driven terminal log analyzer.

Sawmill provides an interactive TUI for browsing, filtering, and triaging structured tool logs, plus a CLI mode for CI pipeline integration. A plugin architecture keeps the core tool-agnostic — plugins teach sawmill how to parse each tool’s output.

Getting Started

• What is Sawmill?
  • Key Concepts
• Quickstart
  • Install
  • Browse interactively
  • Run in CI
  • The .sawmill/ directory

User Guide

• CLI Usage
  • Basic usage
  • Output formats
  • Filtering
  • Suppressing display noise
  • Grouping and summary
  • Waiver generation
• TUI Usage
  • Layout
  • Navigating
  • Severity filtering
  • Searching
  • Sorting
  • Suppressing
  • Waiving
  • Saving
  • Keybinding reference
• CI Integration
  • Check mode
  • Failure threshold
  • Waivers in CI
  • Suppressions do NOT affect CI
  • JSON reports
  • Auditing
  • CI pipeline examples
• Waivers
  • What is a waiver?
  • File format
  • Matching semantics
  • Creating waivers
  • Auto-discovery
  • Author discovery
• The .sawmill/ Directory
  • Overview
  • Directory naming
  • Configuration — config.toml
  • Suppressions — suppress.toml
  • Waivers — waivers.toml
  • Version control

Plugin Guide

• What is a Plugin?
  • Concept
  • What a plugin provides
  • Discovery
  • Auto-detection
• Pre-defined Filters
  • What are pre-defined filters?
  • Listing filters
  • Using filters
  • Worked example
• Writing a Plugin
  • Prerequisites
  • Generate a scaffold
  • The hookspec contract
  • The Message model
  • Filling in hooks
  • Testing
  • Installing

Reference

• CLI Reference
  • Batch mode detection
• File Formats
  • config.toml
  • suppress.toml
  • waivers.toml
  • JSON report
• API Reference
  • Data Models
  • Plugin Interface
  • Core Modules

Development

• Contributing
  • Dev setup
  • Running tests
  • Pre-commit hooks
  • Docker dev loop
  • Building docs