epic-formulae
Version:
Simple data store to house epic formulae
1 lines • 1.77 kB
JSON
{"version":"1.0.0","commands":{"add":{"id":"add","description":"Add a formula to the data store","strict":true,"pluginName":"epic-formulae","pluginAlias":"epic-formulae","pluginType":"core","aliases":[],"examples":["$ formula add -m '(-)-uuu' -r Zeus 'cloud-gatherer'"],"flags":{"metre":{"name":"metre","type":"option","char":"m","description":"Metrical notation: 'u' = breve, '-' = macron, parenthesise ghost syllable if present","required":true,"multiple":false},"referent":{"name":"referent","type":"option","char":"r","description":"Referent. Keep consistent (including case) across related formulae","required":true,"multiple":false}},"args":[{"name":"text","description":"Text of the formula","required":true}],"_globalFlags":{}},"list":{"id":"list","description":"List the formulae from the data store","strict":true,"pluginName":"epic-formulae","pluginAlias":"epic-formulae","pluginType":"core","aliases":[],"examples":["formula list","formula list -g metre","formula list -f csv"],"flags":{"format":{"name":"format","type":"option","char":"f","description":"Output format","multiple":false,"options":["csv","markdown"],"default":"markdown"},"group":{"name":"group","type":"option","char":"g","description":"Group results","multiple":false,"options":["metre","referent"],"default":"referent"}},"args":[],"_globalFlags":{}},"load":{"id":"load","description":"Load forumlae from a CSV file","strict":true,"pluginName":"epic-formulae","pluginAlias":"epic-formulae","pluginType":"core","aliases":[],"examples":["formula load my-formulae.csv","./bin/example-stream | formula load"],"flags":{"ignore-header":{"name":"ignore-header","type":"boolean","char":"i","description":"Ignore header row in loaded file","allowNo":false}},"args":[{"name":"file"}],"_globalFlags":{}}}}