npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dialectik/cli

v0.0.6

Published

Dialectik CLI

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

benoitedukerabenoitedukera

Keywords

oclif

Readme

Dialectik CLI

Dialectik command line interpreter to:

  • compile markdown source
  • start the dev server

oclif Version CircleCI Downloads/week License

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

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.