Skip to content

How To: Generate the JSON Doc Model

Generate to stdout

plissken generate

Pipe to a file or another tool:

plissken generate > model.json
plissken generate | jq '.metadata'

Generate to a File

plissken generate --output model.json

Pretty-Print

plissken generate --pretty

Inspect the Output

The JSON contains metadata, rust_modules, python_modules, and cross_refs. Extract specific sections with jq:

# List all Python classes
plissken generate | jq '[.python_modules[].items[] | select(.kind == "Class") | .name]'

# Show all cross-references
plissken generate | jq '.cross_refs'

# Get project metadata
plissken generate | jq '.metadata'

For the complete schema of every field, see the Data Model Reference.

Specify a Different Project

plissken generate /path/to/project
plissken generate /path/to/plissken.toml