Skip to content

Commit

Permalink
Merge pull request #6 from rdf-ext/readme
Browse files Browse the repository at this point in the history
chore: added help to readme
  • Loading branch information
bergos authored Mar 6, 2024
2 parents 9e1f449 + 2c520ce commit be5e581
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,34 @@ This will read `somePathOrUrl` with content-type auto-detection and write the re
If `--shacl-url` is given, the input will be validated against the given SHACL shape, and the report will be written to the output.
Run `rdf-ext` without any arguments to get a full list of supported parameters.

### Help

```
Usage: rdf-ext-cli [options] [input]
Arguments:
input input
Options:
--input-endpoint <url> input SPARQL endpoint url
--input-query <query> input SPARQL query
--input-type <type> input content type
--shacl-endpoint <url> SHACL SPARQL endpoint url
--shacl-query <query> SHACL SPARQL query
--shacl-type <type> SHACL content type (default: "text/turtle")
--shacl-url <url> SHACL URL
--shacl-debug generate results for successful validations
--shacl-details generate nested result details
--shacl-trace generate results for path traversing
--transform-map-namespace <mapping> map the given namespaces (default: {"index":{}})
--transform-skolem-iris <baseIri> map blank nodes to Skolem IRIs
--transform-to-triples set graph to default graph
--output-prefix <prefix> output prefix (default: {})
--output-type <type> output content type (default: "text/turtle")
--pretty use pretty print serializer
-h, --help display help for command
```

## Examples

See the examples folder for some example commands.

0 comments on commit be5e581

Please sign in to comment.