commonmeta-rs

commonmeta-rs is a Rust library to implement Commonmeta, the common Metadata Model for Scholarly Metadata. Use commonmeta to convert scholarly metadata in a variety of formats, listed below. Commonmeta-rs is work in progress, the first release was on June 17, 2026. Implementations in other languages are also available (Go, Python, Ruby).

commonmeta uses semantic versioning. Currently, its major version number is still at 0, meaning the API is not yet stable, and breaking changes are expected in the internal API and commonmeta JSON format.

Supported Metadata Formats

Commonmeta-rs reads and/or writes these metadata formats:

Format	Name	Content Type	Read	Write
Commonmeta	commonmeta	application/vnd.commonmeta+json	yes	yes
CrossRef XML	crossref_xml	application/vnd.crossref.unixref+xml	yes	yes
Crossref	crossref	application/vnd.crossref+json	yes	n/a
DataCite	datacite	application/vnd.datacite.datacite+json	yes	yes
Schema.org (in JSON-LD)	schema_org	application/vnd.schemaorg.ld+json	yes	yes
RDF XML	rdf_xml	application/rdf+xml	no	later
RDF Turtle	turtle	text/turtle	no	later
CSL-JSON	csl	application/vnd.citationstyles.csl+json	yes	yes
Formatted text citation	citation	text/x-bibliography	n/a	yes
Codemeta	codemeta	application/vnd.codemeta.ld+json	yes	later
Citation File Format (CFF)	cff	application/vnd.cff+yaml	yes	later
JATS	jats	application/vnd.jats+xml	later	later
CSV	csv	text/csv	no	later
BibTex	bibtex	application/x-bibtex	yes	yes
RIS	ris	application/x-research-info-systems	yes	yes
InvenioRDM	inveniordm	application/vnd.inveniordm.v1+json	yes	yes
JSON Feed	jsonfeed	application/feed+json	yes	later
OpenAlex	openalex	n/a	yes	no

commonmeta: the Commonmeta format is the native format for the library and used internally. Planned: we plan to implement this format for the v1.0 public release. Later: we plan to implement this format in a later release.

Build & run

cargo build
cargo test

The commonmeta binary has seven subcommands: convert, encode, decode, list, push, put, and match.

# Encode/decode a Crockford base32 identifier suffix
cargo run -- encode 10.5555
cargo run -- decode 10.5555/nwbyp-29t86

# Convert a single record between formats, fetching it by DOI
cargo run -- convert 10.5555/12345678 --from crossref --to csl

# Convert a local file and write the result to disk
cargo run -- convert record.json --from commonmeta --to csl --file out.json

# Render a formatted citation (CSL style + locale)
cargo run -- convert 10.5555/12345678 --from crossref --to citation --style apa --locale en-US

# Fetch a batch of records from an API and write them as a JSON array
cargo run -- list --from crossref --number 100 --type journal-article --file out.json

# Read VRAIX metadata from a local SQLite file
cargo run -- list crossref-2026-06-15.sqlite3 --from vraix --number 0 --to commonmeta --file out.json.gz

# Parquet output (.parquet file extension, --to commonmeta only): records are split into batches of 100,000, written in parallel, and zstd-compressed
cargo run --release -- list crossref-2026-06-15.sqlite3 --from vraix --number 0 --file out.parquet

# Register records with a live InvenioRDM instance (creates/updates and publishes
# real records — registration is currently only supported with --to inveniordm)
cargo run -- push --from crossref --number 10 --to inveniordm --host rogue-scholar.org --token TOKEN

# Same as push, but for a single record (DOI, URL, or file path)
cargo run -- put 10.5555/12345678 --from crossref --to inveniordm --host rogue-scholar.org --token TOKEN

# Match a free-text affiliation string to a ROR organization
cargo run -- match "Leibniz Universität Hannover"
cargo run -- match "Leibniz Universität Hannover" --to inveniordm

Use cargo run -- <subcommand> --help for the full list of options for each subcommand.

Documentation

Documentation (work in progress) for using the library is available at the commonmeta-rs Documentation website.

commonmeta 0.4.1

commonmeta-rs

Supported Metadata Formats

Build & run

Documentation

Meta