cme.1.html

<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>CMTools</title>
    <link rel="stylesheet" href="/css/site.css">
</head>
<body>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="search.html">Search</a></li>
    <li><a href="https://github.com/caltechlibrary/CMTools">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>cme</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>cme CODEMETA_JSON [OPTION …]</p>
<p>cme CODEMETA_JSON ATTRIBUTE_NAME [ATTRIBUTE_NAME …] [OPTION …]</p>
<p>cme CODEMETA_JSON ATTRIBUTE_NAME=ATTRIBUTE_VALUE
[ATTRIBUTE_NAME=ATTRIBUTE_VALUE …] [OPTION …]</p>
<h1 id="description">DESCRIPTION</h1>
<p>cme is a CodeMeta file editing tool. When called with only the
CODEMETA_JSON filename it will read in the CodeMeta file, report any
errors, extrapolate values if needed. It will then display a pretty
printed normalized version of your CodeMeta file.</p>
<p>cme will also let you modify specific attributes in a CodeMeta file.
It does this by reading the CodeMeta file and prompting you to type in
the value. If you use the editor option it’ll launch your editor use it
to set the value saving changes are saved back to the CodeMeta file.</p>
<p>For attributes like author, contributor, maintainer and keyword
should be typed in using YAML syntax. The YAML will be converted to JSON
and used to update your CodeMeta file.</p>
<p>If you provide one or more attribute names the attributes will be
available to edit in the order you’ve requested them to be edited.</p>
<p>Two date fields are set if they are not previously set, “dateCreated”
and “dateModified”. The “dateModified” is updated each time you change
something in the CodeMeta file unless you explicitly edit it.</p>
<p>For the simple fields like version, name, description, releaseNotes
you can set their values directly on the command line using an equal
sign between the attribute name and the value. If the value includes
spaces you need to wrap them in quotes. See the EXAMPLE below.</p>
<h1 id="option">OPTION</h1>
<dl>
<dt>-h, –help</dt>
<dd>
display help
</dd>
<dt>-v, –version</dt>
<dd>
display version
</dd>
<dt>-l, –license</dt>
<dd>
display license
</dd>
<dt>-e, –editor</dt>
<dd>
use the editor named in the EDITOR environment variable. If variable is
unset then use the default text editor. On Windows that is notepad.exe.
On Linux and macOS it is nano.
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Create a new CodeMeta file. If no attribute names are included then
you will be prompt for each attribute.</p>
<pre><code>cme codemeta.json</code></pre>
<p>Set the version number in your codemeta.json file and add/replace the
<code>.releaseNotes</code>.</p>
<pre><code>cme codemeta.json version releaseNotes</code></pre>
<p>Set the version number to “0.0.1” and release notes to “Initial
Concept” without being prompted.</p>
<pre class="shell"><code>cme codemeta.json version=0.0.1 release=&#39;Initial Concept&#39;</code></pre>
<p>If Micro Editor is installed you can edit the description in micro
using the “-e” option.</p>
<pre class="shell"><code>cme codemeta.json description -e</code></pre>
</section>
</body>
</html>