Guide

Task-oriented documentation. Each page walks through one part of figue with runnable examples. Read it front to back the first time, then jump to whatever you need.

  1. Getting Started — install figue, parse your first argument
  2. CLI Arguments — positionals, flags, short options, counting, --
  3. Subcommands — enum-driven subcommands, nesting, renames, global flags
  4. Config Files — JSON/JSONC, search paths, custom formats
  5. Environment Variables — prefixes, nesting, aliases
  6. Layered Configuration — the builder, the driver, merge precedence
  7. Defaults & Optionals — what is required, what is not
  8. Environment Substitution${VAR} interpolation
  9. Errors & Diagnostics — exit codes, the config dump, suggestions
  10. Help & Completions--help, --html-help, --version, shells
  11. JSON Schema Export — editor autocomplete for config files
  12. Requirements Extraction — per-operation required fields

New here? Start with Getting Started.