@dialectik/cli v0.0.6

Dialectik CLI

Dialectik command line interpreter to:

• compile markdown source
• start the dev server

• Usage
• Commands

Usage

$ npm install -g @dialectik/cli
$ dialectik COMMAND
running command...
$ dialectik (--version)
@dialectik/cli/0.0.6 darwin-arm64 node-v18.12.1
$ dialectik --help [COMMAND]
USAGE
  $ dialectik COMMAND
...

Commands

• dialectik check
• dialectik compile
• dialectik compile h5p SOURCE
• dialectik compile html SOURCE
• dialectik compile to h5p SOURCE
• dialectik compile to html SOURCE
• dialectik dev SOURCE
• dialectik help [COMMANDS]
• dialectik plugins
• dialectik plugins:install PLUGIN...
• dialectik plugins:inspect PLUGIN...
• dialectik plugins:install PLUGIN...
• dialectik plugins:link PLUGIN
• dialectik plugins:uninstall PLUGIN...
• dialectik plugins:uninstall PLUGIN...
• dialectik plugins:uninstall PLUGIN...
• dialectik plugins update

dialectik check

Check for updates

USAGE
  $ dialectik check

DESCRIPTION
  Check for updates

EXAMPLES
  $ dialectik check version

See code: dist/commands/check.ts

dialectik compile

Compile files into different formats (currently html and h5P).

USAGE
  $ dialectik compile

DESCRIPTION
  Compile files into different formats (currently html and h5P).

EXAMPLES
  $ dialectik compile to html <input file>

  $ dialectik compile to h5p <input file>

See code: dist/commands/compile/index.ts

dialectik compile h5p SOURCE

Compile Markdown (.md) source to H5P component.

USAGE
  $ dialectik compile h5p SOURCE [-i <value>] [-t <value>]

ARGUMENTS
  SOURCE  Markdown source to compile

FLAGS
  -i, --id=<value>      Source identifier
  -t, --target=<value>  Target directory

DESCRIPTION
  Compile Markdown (.md) source to H5P component.

ALIASES
  $ dialectik compile to h5p

EXAMPLES
  $ dialectik compile to h5p ./hello/hello.md --id Hello

dialectik compile html SOURCE

Compile Markdown (.md) source to html.

USAGE
  $ dialectik compile html SOURCE [-i <value>] [-t <value>] [-c] [-j] [-p] [-l]

ARGUMENTS
  SOURCE  Markdown source to compile

FLAGS
  -c, --nobundlestyle   Do not bundle style (see style flag)
  -i, --id=<value>      Source identifier
  -j, --nobundlejs      Do not bundle js
  -l, --license         Generate webpack license
  -p, --nobundleimage   Do not bundle Image
  -t, --target=<value>  Target directory

DESCRIPTION
  Compile Markdown (.md) source to html.

ALIASES
  $ dialectik compile to html

EXAMPLES
  $ dialectik compile to html ./hello/hello.md --id Hello

dialectik compile to h5p SOURCE

Compile Markdown (.md) source to H5P component.

USAGE
  $ dialectik compile to h5p SOURCE [-i <value>] [-t <value>]

ARGUMENTS
  SOURCE  Markdown source to compile

FLAGS
  -i, --id=<value>      Source identifier
  -t, --target=<value>  Target directory

DESCRIPTION
  Compile Markdown (.md) source to H5P component.

ALIASES
  $ dialectik compile to h5p

EXAMPLES
  $ dialectik compile to h5p ./hello/hello.md --id Hello

dialectik compile to html SOURCE

Compile Markdown (.md) source to html.

USAGE
  $ dialectik compile to html SOURCE [-i <value>] [-t <value>] [-c] [-j] [-p] [-l]

ARGUMENTS
  SOURCE  Markdown source to compile

FLAGS
  -c, --nobundlestyle   Do not bundle style (see style flag)
  -i, --id=<value>      Source identifier
  -j, --nobundlejs      Do not bundle js
  -l, --license         Generate webpack license
  -p, --nobundleimage   Do not bundle Image
  -t, --target=<value>  Target directory

DESCRIPTION
  Compile Markdown (.md) source to html.

ALIASES
  $ dialectik compile to html

EXAMPLES
  $ dialectik compile to html ./hello/hello.md --id Hello

dialectik dev SOURCE

Start Dev Server

USAGE
  $ dialectik dev SOURCE [-i <value>] [-s <value>]

ARGUMENTS
  SOURCE  Markdown source to compile

FLAGS
  -i, --id=<value>     Source identifier
  -s, --style=<value>  CSS style source

DESCRIPTION
  Start Dev Server

EXAMPLES
  $ dialectik dev ./hello/hello.md --id Hello

See code: dist/commands/dev.ts

dialectik help [COMMANDS]

Display help for dialectik.

USAGE
  $ dialectik 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 dialectik.

See code: @oclif/plugin-help

dialectik plugins

List installed plugins.

USAGE
  $ dialectik plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ dialectik plugins

See code: @oclif/plugin-plugins

dialectik plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ dialectik plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ dialectik plugins add

EXAMPLES
  $ dialectik plugins:install myplugin 

  $ dialectik plugins:install https://github.com/someuser/someplugin

  $ dialectik plugins:install someuser/someplugin

dialectik plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ dialectik plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ dialectik plugins:inspect myplugin

dialectik plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ dialectik plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ dialectik plugins add

EXAMPLES
  $ dialectik plugins:install myplugin 

  $ dialectik plugins:install https://github.com/someuser/someplugin

  $ dialectik plugins:install someuser/someplugin

dialectik plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ dialectik plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ dialectik plugins:link myplugin

dialectik plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ dialectik plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dialectik plugins unlink
  $ dialectik plugins remove

dialectik plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ dialectik plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dialectik plugins unlink
  $ dialectik plugins remove

dialectik plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ dialectik plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dialectik plugins unlink
  $ dialectik plugins remove

dialectik plugins update

Update installed plugins.

USAGE
  $ dialectik plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.