Guide

Task-oriented documentation. Each page walks you through a workflow or explains concepts in context. Read sequentially or jump to the topic you need.

New here? Start with Getting Started, then Why facet?.

How-to, by task:

• JSON — serialize and deserialize with span-aware errors
• CLI & config — typed args, env vars, and config files with figue
• Pretty-printing — readable, redacted, colored output
• Custom defaults — per-field defaults with facet-default
• Error types — thiserror-style errors from doc comments
• Validation — reject bad data during deserialization
• Schema & code generation — TypeScript, Zod, JSON Schema
• Type Support — third-party types that already implement Facet

For the full constellation of crates, see the Ecosystem map.