oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g markblocks
$ markblocks COMMAND
running command...
$ markblocks (--version)
markblocks/0.1.2 darwin-arm64 node-v20.5.1
$ markblocks --help [COMMAND]
USAGE
  $ markblocks COMMAND
...

Commands

• markblocks INPUTFILE [OUTFILE]
• markblocks help [COMMANDS]

markblocks INPUTFILE [OUTFILE]

Adds adds human-readable block ids to every paragraph in a Markdown document.

USAGE
  $ markblocks  INPUTFILE [OUTFILE] [-f] [-h] [-r] [-s]

ARGUMENTS
  INPUTFILE  The path to the markdown document.
  OUTFILE    The output file for the generated output. If not provided, markblocks will not run unless the --force flag
             is provided.

FLAGS
  -f, --force           Whether to add block ids to an existing document in the event an outFile is not provided.
  -h, --includeHeaders  By default, blockifier will not turn markdown headers into blocks. Including this option will
                        generate block ids for headers as well.
  -r, --random          Whether to use random or human-readable block ids. If enabled, the block ids will be random.
  -s, --sequential      By default, blockifier will try to generate block ids based on the document's header structure
                        (e.g. 1.0.0, 1.0.1, etc.). This option will generate ids purely based on each paragraph break.
                        No effect if --random is enabled.

DESCRIPTION
  Adds adds human-readable block ids to every paragraph in a Markdown document.

EXAMPLES
  Add block ids to an existing document.

    $ markblocks input.md output.md

  Add block ids to an existing document.

    $ markblocks input.md -f

See code: dist/index.ts

markblocks help [COMMANDS]

Display help for markblocks.

USAGE
  $ markblocks help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for markblocks.

See code: @oclif/plugin-help