@gmb/bitmark-cli

{ "commands": { "breakscape": { "aliases": [], "args": { "input": { "description": "file to read, or text. If not specified, input will be from <stdin>", "name": "input", "required": false } }, "description": "Breakscape text", "examples": [ "<%= config.bin %> <%= command.id %> '[.article] Hello World'", "<%= config.bin %> <%= command.id %> input.txt -o output.txt" ], "flags": { "output": { "char": "o", "description": "output file. If not specified, output will be to <stdout>", "helpGroup": "File output", "name": "output", "hasDynamicHelp": false, "helpValue": "FILE", "multiple": false, "type": "option" }, "append": { "char": "a", "dependsOn": [ "output" ], "description": "append to the output file (default is to overwrite)", "helpGroup": "File output", "name": "append", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "breakscape", "pluginAlias": "@gmb/bitmark-cli", "pluginName": "@gmb/bitmark-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": false, "relativePath": [ "dist", "commands", "breakscape.js" ] }, "convert": { "aliases": [], "args": { "input": { "description": "file to read, or bitmark or json string. If not specified, input will be from <stdin>", "name": "input", "required": false } }, "description": "Convert between bitmark formats", "examples": [ "<%= config.bin %> <%= command.id %> '[.article] Hello World'", "<%= config.bin %> <%= command.id %> '[{\"bitmark\": \"[.article] Hello World\",\"bit\": { \"type\": \"article\", \"format\": \"bitmark++\", \"body\": \"Hello World\" }}]'", "<%= config.bin %> <%= command.id %> input.json -o output.bitmark", "<%= config.bin %> <%= command.id %> input.bitmark -o output.json", "<%= config.bin %> <%= command.id %> -f ast input.json -o output.ast.json" ], "flags": { "version": { "char": "v", "description": "version of bitmark to use (default: latest)", "name": "version", "hasDynamicHelp": false, "multiple": false, "options": [ "2", "3" ], "type": "option" }, "format": { "char": "f", "description": "output format. If not specified, bitmark is converted to JSON, and JSON / AST is converted to bitmark", "name": "format", "hasDynamicHelp": false, "multiple": false, "options": [ "bitmark", "json", "ast" ], "type": "option" }, "warnings": { "char": "w", "description": "enable warnings in the output", "name": "warnings", "allowNo": false, "type": "boolean" }, "pretty": { "char": "p", "description": "prettify the JSON output with indent", "helpGroup": "JSON Formatting", "name": "pretty", "allowNo": false, "type": "boolean" }, "indent": { "dependsOn": [ "pretty" ], "description": "prettify indent (default:2)", "helpGroup": "JSON Formatting", "name": "indent", "hasDynamicHelp": false, "helpValue": "INDENT", "multiple": false, "type": "option" }, "plainText": { "description": "output text as plain text rather than JSON (default: set by bitmark version)", "helpGroup": "JSON Formatting", "name": "plainText", "allowNo": false, "type": "boolean" }, "excludeUnknownProperties": { "description": "exclude unknown properties in the JSON output", "helpGroup": "JSON Formatting", "name": "excludeUnknownProperties", "allowNo": false, "type": "boolean" }, "explicitTextFormat": { "description": "include bitmark text format in bitmark even if it is the default (bitmark++)", "helpGroup": "Bitmark Formatting", "name": "explicitTextFormat", "allowNo": false, "type": "boolean" }, "spacesAroundValues": { "description": "number of spaces around values in bitmark (default: 1)", "helpGroup": "Bitmark Formatting", "name": "spacesAroundValues", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cardSetVersion": { "description": "version of card set to use in bitmark (default: set by bitmark version)", "helpGroup": "Bitmark Formatting", "name": "cardSetVersion", "hasDynamicHelp": false, "multiple": false, "options": [ "1", "2" ], "type": "option" }, "output": { "char": "o", "description": "output file. If not specified, output will be to <stdout>", "helpGroup": "File output", "name": "output", "hasDynamicHelp": false, "helpValue": "FILE", "multiple": false, "type": "option" }, "append": { "char": "a", "dependsOn": [ "output" ], "description": "append to the output file (default is to overwrite)", "helpGroup": "File output", "name": "append", "allowNo": false, "type": "boolean" }, "parser": { "description": "parser to use", "helpGroup": "Parser Options", "name": "parser", "default": "peggy", "hasDynamicHelp": false, "multiple": false, "options": [ "peggy", "antlr" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "convert", "pluginAlias": "@gmb/bitmark-cli", "pluginName": "@gmb/bitmark-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": false, "relativePath": [ "dist", "commands", "convert.js" ] }, "convertText": { "aliases": [], "args": { "input": { "description": "file to read, or text or json string. If not specified, input will be from <stdin>", "name": "input", "required": false } }, "description": "Convert between bitmark text formats", "examples": [ "<%= config.bin %> <%= command.id %> 'Hello World'", "<%= config.bin %> <%= command.id %> '[{\"type\":\"paragraph\",\"content\":[{\"text\":\"Hello World\",\"type\":\"text\"}],\"attrs\":{}}]'", "<%= config.bin %> <%= command.id %> input.json -o output.txt", "<%= config.bin %> <%= command.id %> input.txt -o output.json" ], "flags": { "textFormat": { "char": "f", "description": "conversion format", "name": "textFormat", "default": "bitmark++", "hasDynamicHelp": false, "multiple": false, "options": [ "bitmark++" ], "type": "option" }, "pretty": { "char": "p", "description": "prettify the JSON output with indent", "helpGroup": "JSON Formatting", "name": "pretty", "allowNo": false, "type": "boolean" }, "indent": { "dependsOn": [ "pretty" ], "description": "prettify indent (default:2)", "helpGroup": "JSON Formatting", "name": "indent", "hasDynamicHelp": false, "helpValue": "INDENT", "multiple": false, "type": "option" }, "output": { "char": "o", "description": "output file. If not specified, output will be to <stdout>", "helpGroup": "File output", "name": "output", "hasDynamicHelp": false, "helpValue": "FILE", "multiple": false, "type": "option" }, "append": { "char": "a", "dependsOn": [ "output" ], "description": "append to the output file (default is to overwrite)", "helpGroup": "File output", "name": "append", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "convertText", "pluginAlias": "@gmb/bitmark-cli", "pluginName": "@gmb/bitmark-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": false, "relativePath": [ "dist", "commands", "convertText.js" ] }, "info": { "aliases": [], "args": { "info": { "default": "list", "description": "information to return. If not specified, a list of bits will be returned", "name": "info", "options": [ "list", "bit" ], "required": false } }, "description": "Display information about bitmark", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --all", "<%= config.bin %> <%= command.id %> list --deprecated", "<%= config.bin %> <%= command.id %> bit --bit=cloze", "<%= config.bin %> <%= command.id %> -f json -p bit --bit=still-image-film" ], "flags": { "format": { "char": "f", "description": "output format. If not specified, the ouput will be text", "name": "format", "default": "text", "hasDynamicHelp": false, "multiple": false, "options": [ "text", "json" ], "type": "option" }, "bit": { "description": "bit to filter. If not specified, all bits will be returned", "exclusive": [ "all", "deprecated" ], "name": "bit", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "deprecated": { "description": "output deprecated bits", "name": "deprecated", "allowNo": false, "type": "boolean" }, "all": { "description": "output all bits including deprecated", "exclusive": [ "deprecated" ], "name": "all", "allowNo": false, "type": "boolean" }, "pretty": { "char": "p", "description": "prettify the JSON output with indent", "helpGroup": "JSON Formatting", "name": "pretty", "allowNo": false, "type": "boolean" }, "indent": { "dependsOn": [ "pretty" ], "description": "prettify indent (default:2)", "helpGroup": "JSON Formatting", "name": "indent", "hasDynamicHelp": false, "helpValue": "INDENT", "multiple": false, "type": "option" }, "output": { "char": "o", "description": "output file. If not specified, output will be to <stdout>", "helpGroup": "File output", "name": "output", "hasDynamicHelp": false, "helpValue": "FILE", "multiple": false, "type": "option" }, "append": { "char": "a", "dependsOn": [ "output" ], "description": "append to the output file (default is to overwrite)", "helpGroup": "File output", "name": "append", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "info", "pluginAlias": "@gmb/bitmark-cli", "pluginName": "@gmb/bitmark-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": false, "relativePath": [ "dist", "commands", "info.js" ] }, "unbreakscape": { "aliases": [], "args": { "input": { "description": "file to read, or text. If not specified, input will be from <stdin>", "name": "input", "required": false } }, "description": "Unbreakscape text", "examples": [ "<%= config.bin %> <%= command.id %> '[^.article] Hello World'", "<%= config.bin %> <%= command.id %> input.txt -o output.txt" ], "flags": { "output": { "char": "o", "description": "output file. If not specified, output will be to <stdout>", "helpGroup": "File output", "name": "output", "hasDynamicHelp": false, "helpValue": "FILE", "multiple": false, "type": "option" }, "append": { "char": "a", "dependsOn": [ "output" ], "description": "append to the output file (default is to overwrite)", "helpGroup": "File output", "name": "append", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "unbreakscape", "pluginAlias": "@gmb/bitmark-cli", "pluginName": "@gmb/bitmark-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": false, "relativePath": [ "dist", "commands", "unbreakscape.js" ] } }, "version": "4.5.0" }