Pre-release. Until the official launch, content may change, including published files.
Skip to content

Source: https://datamodels.jp/en/toolkit/ · Text CC BY 4.0

Toolkit ​

datamodels-toolkit is an open-source command-line tool and GitHub Action. The command is datamodels. With it you can:

  • Publish your own data models with fixed URLs on a site of your own, a node. The site has catalog.json, the @context, JSON Schemas, a vocabulary, examples, and a page for every type and attribute. An example: models.gtt-project.org, the models of the GTT plugin for Redmine.
  • Convert a CSV list into entities of a model of this catalog.

Not sure yet whether you need a site of your own? See Your own data models.

Running it ​

You need Node.js 24 or later. The commands run a release from GitHub with npx; there is nothing to install.

bash
npx github:geolonia/datamodels-toolkit#v0.3.3 --help

The examples in this section use this release. All commands and options are in --help and the README. This section explains them task by task.

Pages ​

Publish your site ​

  • Starting a site: start a node with init, and publish it on GitHub Pages and your own domain.
  • Adding models: add models with add and extend, and write their attributes.
  • Checking and building: check, build, and the GitHub Action that publishes.
  • Versions: change a published model with bump, and move to a newer toolkit with upgrade.

Work with data ​

Reference ​