NAME

cmt

SYNOPSIS

cmt INPUT_NAME OPTIONS cmt INPUT_NAME [OUTPUT_NAME] OPTIONS cmt INPUT_NAME [OUTPUT_NAME OUTPUT_NAME …] OPTIONS

DESCRIPTION

cmt provides tooling for working with CodeMeta objects targeting your Python, Go, JavaScript or TypeScript build process.

cmt can be used to generate various code artifacts including the following.

• CITATION.cff
• about.md
• version.py, version.go, version.js or version.ts

OPTIONS

Options come as the last parameter(s) on the command line.

-h, –help

display help

-v, –version

display version

-l, –license

display license

-f, –format

output format to use when piping the output to another programming.

-d, –deno

update the deno.json file tasks based on output files requested.

EXAMPLES

Here’s an example of rendering CITATION.cff from a codemeta.json file. The second version shows how to use the format option.

cmt codemeta.json CITATION.cff
cmt codemeta.json --format=cff >CITATION.cff

Here’s an example of rendering version.ts, version.py, and version.go from codemeta.json file.

cmt codemeta.json version.ts
cmt codemeta.json version.py
cmt codemeta.json version.go

Here’s an example of generating an “about.md” file from the CodeMeta file.

cmt codemeta.json about.md

You can also just stack the output files you need one after another. This is an example of creating the files to bootstrap a TypeScript project.

cmt codemeta.json about.md CITATION.cff version.ts

The “–deno” option can trail the above command to update the deno.json file with a set of tasks to update the files you have specified.

cmt codemeta.json about.md CITATION.cff version.ts --deno

This will create a “gen-code” task that will rebuild those files based on the current contents of the codemeta.json file.