pyshacl - Man Page

manual page for PySHACL Version: 0.30.1

Description

usage: pyshacl [-h] [-s [SHACL]] [-e [ONT]] [-i {none,rdfs,owlrl,both}] [-m]

[-q] [-im] [-a] [-j] [-it] [--abort] [--allow-info] [-w] [--max-depth [MAX_DEPTH]] [-d] [--focus [FOCUS]] [--shape [SHAPE]] [-f {human,table,turtle,xml,json-ld,nt,n3}] [-df {auto,turtle,xml,json-ld,nt,n3}] [-sf {auto,turtle,xml,json-ld,nt,n3}] [-ef {auto,turtle,xml,json-ld,nt,n3}] [-V] [-o [OUTPUT]] [--rules] [--server] [DataGraph]

PySHACL 0.30.1 Validator command line tool.

positional arguments

DataGraph

The file or endpoint containing the Target Data Graph.

options

-h,  --help

show this help message and exit

-s,  --shapes,  --shacl [SHACL]

A file containing the SHACL Shapes Graph.

-e,  --ont-graph [ONT]

A file path or URL to a document containing extra ontological information. RDFS and OWL definitions from this are used to inoculate the DataGraph.

-i,  --inference {none,rdfs,owlrl,both}

Choose a type of inferencing to run against the Data Graph before validating.

-m,  --metashacl

Validate the SHACL Shapes graph against the shaclshacl Shapes Graph before validating the Data Graph.

-q,  --sparql-mode

Treat the DataGraph as a SPARQL endpoint, validate the graph at the SPARQL endpoint.

-im,  --imports

Allow import of sub-graphs defined in statements with owl:imports.

-a,  --advanced

Enable features from the SHACL Advanced Features specification.

-j,  --js

Enable features from the SHACL-JS Specification.

-it,  --iterate-rules

Run Shape's SHACL Rules iteratively until the data_graph reaches a steady state.

--abort

Abort on first invalid data.

--allow-info,  --allow-infos

Shapes marked with severity of Info will not cause result to be invalid.

-w,  --allow-warning,  --allow-warnings

Shapes marked with severity of Warning or Info will not cause result to be invalid.

--max-depth [MAX_DEPTH]

The maximum number of SHACL shapes "deep" that the validator can go before reaching an "endpoint" constraint.

-d,  --debug

Output additional verbose runtime messages.

--focus [FOCUS]

Optional IRIs of focus nodes from the DataGraph, the shapes will validate only these node. Comma-separated list.

--shape [SHAPE]

Optional IRIs of a NodeShape or PropertyShape from the SHACL ShapesGraph, only these shapes will be used to validate the DataGraph. Comma-separated list.

-f,  --format {human,table,turtle,xml,json-ld,nt,n3}

Choose an output format. Default is "human".

-df,  --data-file-format {auto,turtle,xml,json-ld,nt,n3}

Explicitly state the RDF File format of the input DataGraph file. Default="auto".

-sf,  --shacl-file-format {auto,turtle,xml,json-ld,nt,n3}

Explicitly state the RDF File format of the input SHACL file. Default="auto".

-ef,  --ont-file-format {auto,turtle,xml,json-ld,nt,n3}

Explicitly state the RDF File format of the extra ontology file. Default="auto".

-V,  --version

Show PySHACL version and exit.

-o,  --output [OUTPUT]

Send output to a file (defaults to stdout).

--rules

Ignore validation options, run PySHACL in Rules Expansion mode. Same as `pyshacl_rules`.

--server

Ignore all the rest of the options, start the HTTP Server. Same as `pyshacl_server`.

See Also

The full documentation for PySHACL is maintained as a Texinfo manual.  If the info and PySHACL programs are properly installed at your site, the command

info PySHACL

should give you access to the complete manual.

Info

June 2025 PySHACL Version: 0.30.1