---
name: "schema-salad-tool"
section: "1"
platform: "linux"
package: "python3-schema-salad"
version: "8.9.20250408123006-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/schema-salad-tool"
---

# schema-salad-tool(1)

Schema Annotations for Linked Avro Data (SALAD)

## NAME

schema-salad-tool - Schema Annotations for Linked Avro Data (SALAD)

## DESCRIPTION

usage: schema-salad-tool \[-h\] \[--rdf-serializer RDF\_SERIALIZER\] \[--skip-schemas\]

-

  \[--strict-foreign-properties\] \[--print-jsonld-context\] \[--print-rdfs\] \[--print-avro\] \[--print-rdf\] \[--print-pre\] \[--print-index\] \[--print-metadata\] \[--print-inheritance-dot\] \[--print-fieldrefs-dot\] \[--codegen language\] \[--codegen-target CODEGEN\_TARGET\] \[--codegen-examples directory\] \[--codegen-package dotted.package\] \[--codegen-copyright copyright\_string\] \[--codegen-spdx-copyright-text spdx\_copyright\_text \[spdx\_copyright\_text ...\]\] \[--codegen-spdx-license-identifier spdx\_license\_identifier\] \[--codegen-parser-info parser\_info\] \[--print-oneline\] \[--print-doc\] \[--strict \| **--non-strict\]** \[--verbose \| **--quiet** \| **--debug\]** \[--only ONLY\] \[--redirect REDIRECT\] \[--brand BRAND\] \[--brandlink BRANDLINK\] \[--brandstyle BRANDSTYLE\] \[--brandinverse\] \[--primtype PRIMTYPE\] \[--version\] \[schema\] \[document ...\]

### positional arguments:

-

  schema document

### options:

- **-h**, **--help**

  show this help message and exit

- **--rdf-serializer** RDF\_SERIALIZER

  Output RDF serialization format used by **--printrdf**(one of turtle (default), n3, nt, xml)

- **--skip-schemas**

  If specified, ignore $schemas sections.

- **--strict-foreign-properties**

  Strict checking of foreign properties

- **--print-jsonld-context**

  Print JSON-LD context for schema

- **--print-rdfs**

  Print RDF schema

- **--print-avro**

  Print Avro schema

- **--print-rdf**

  Print corresponding RDF graph for document

- **--print-pre**

  Print document after preprocessing

- **--print-index**

  Print node index

- **--print-metadata**

  Print document metadata

- **--print-inheritance-dot**

  Print graphviz file of inheritance

- **--print-fieldrefs-dot**

  Print graphviz file of field refs

- **--codegen** language

  Generate classes in target language, currently supported: python, java, typescript, dotnet, cpp, dlang

- **--codegen-target** CODEGEN\_TARGET

  Defaults to sys.stdout for Python/C++/Dlang and ./ for Java/TypeScript/.Net

- **--codegen-examples** directory

  Directory of example documents for test case generation (Java/TypeScript/.Net/Dlang only).

- **--codegen-package** dotted.package

  Optional override of the package name which is other derived from the base URL (Java/TypeScript/.Net/Dlang only).

- **--codegen-copyright** copyright\_string

  Optional copyright of the input schema.

- **--codegen-spdx-copyright-text** spdx\_copyright\_text \[spdx\_copyright\_text ...\]

  List of copyright text. Each entry will show up as 'SPDX-FileCopyrightText: ...' (Currently c++ only)

- **--codegen-spdx-license-identifier** spdx\_license\_identifier

  Optional spdx license identifier, e.g.: GPL-3.0-only (Currently c++ only)

- **--codegen-parser-info** parser\_info

  Optional parser name which is accessible via resulted parser API (Python and Dlang only)

- **--print-oneline**

  Print each error message in oneline

- **--print-doc**

  Print HTML schema documentation page

- **--strict**

  Strict validation (unrecognized or out of place fields are error)

- **--non-strict**

  Lenient validation (ignore unrecognized fields)

- **--verbose**

  Default logging

- **--quiet**

  Only print warnings and errors.

- **--debug**

  Print even more logging

- **--only** ONLY

  Use with **--print-doc**, document only listed types

- **--redirect** REDIRECT

  Use with **--print-doc**, override default link for type

- **--brand** BRAND

  Use with **--print-doc**, set the 'brand' text in nav bar

- **--brandlink** BRANDLINK

  Use with **--print-doc**, set the link for 'brand' in nav bar

- **--brandstyle** BRANDSTYLE

  Use with **--print-doc**, HTML code to link to an external style sheet

- **--brandinverse**

  Use with **--print-doc**

- **--primtype** PRIMTYPE

  Use with **--print-doc**, link to use for primitive types (string, int etc)

- **--version**, **-v**

  Print version