Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command-Line Help for iguazu

This document contains the help content for the iguazu command-line program.

Command Overview:

iguazu

Usage: iguazu <COMMAND>

Subcommands:
  • info — Describe the entities in the file
  • schema — Dump the schema as JSON
  • convert — Convert between formats

iguazu info

Describe the entities in the file

Usage: iguazu info [OPTIONS] [FILENAME]

Arguments:
  • <FILENAME> — Input filename
Options:
  • -f, --format <FORMAT[:OPTION=VALUE:OPTION=VALUE...]> — Input format and : separated options (if not specified, inferred from filename)
  • -s, --schema <SCHEMA> — Schema override from file
  • -e, --entity <ENTITY> — Select an entity by path within the file

iguazu schema

Dump the schema as JSON

Usage: iguazu schema [OPTIONS] [FILENAME]

Arguments:
  • <FILENAME> — Input filename
Options:
  • -f, --format <FORMAT[:OPTION=VALUE:OPTION=VALUE...]> — Input format and : separated options (if not specified, inferred from filename)
  • -s, --schema <SCHEMA> — Schema override from file
  • -e, --entity <ENTITY> — Select an entity by path within the file

iguazu convert

Convert between formats

Usage: iguazu convert [OPTIONS] [FILENAME] [OUT_FILENAME]

Arguments:
  • <FILENAME> — Input filename
  • <OUT_FILENAME>
Options:
  • -f, --format <FORMAT[:OPTION=VALUE:OPTION=VALUE...]> — Input format and : separated options (if not specified, inferred from filename)
  • -s, --schema <SCHEMA> — Schema override from file
  • -e, --entity <ENTITY> — Select an entity by path within the file
  • --build-summary — Build default summary of all entities
  • -F, --out-format <OUT_FORMAT>

This document was generated automatically by clap-markdown.