Skip to content

Command line interface

The iolanta command renders Linked Data resources from local files, URLs, queries, search results, and Jinja2 Markdown templates.

Use one input mode at a time:

  • a positional URL or file path,
  • --query,
  • --search,
  • --render-template.

Reference

iolanta

Render a given URL.

Usage

iolanta [OPTIONS][URL]

Arguments

Name Description Required
URL No

Options

Name Description Required Default
--query SPARQL query to execute. No -
--search Notion to look up across linked-data search APIs. No -
--render-template Jinja2 Markdown template to render. No -
--as No -
--language Data language to prefer. No C
--log-level No LogLevel.ERROR
--install-completion Install completion for the current shell. No -
--show-completion Show completion for the current shell, to copy it or customize the installation. No -

Commands

No commands available

Common modes

Render a URL or local file as an output datatype:

iolanta https://orcid.org/0000-0002-1825-0097 --as title

Run a SPARQL query and render the result:

iolanta --query 'SELECT * WHERE { ?s ?p ?o } LIMIT 10' --as table

Search Linked Data APIs and emit JSON Lines:

iolanta --search 'Isaac Asimov' --as jsonl

Pre-render a Jinja2 Markdown document and redirect the rendered Markdown to a file:

iolanta --render-template source.jinja2.md > source.output.md

Template rendering

--render-template prints rendered Markdown to stdout. Use shell redirection to write the output to a file.

Template rendering uses the template file's parent directory as Iolanta.project_root. Templates can use local YAML-LD files in that directory, project data, installed Iolanta facilities, and normal web loading.

The v1 Jinja2 helper surface is:

  • as filter: render a node, path, or IRI as an Iolanta datatype.
  • uri filter: convert a path, string, or URIRef to URIRef.
  • sparql(...): execute a SPARQL file and return Markdown table output.
  • path_to_uri(...): convert paths to file IRIs.
  • docs, iolanta, and URIRef globals.