Socket
Book a DemoInstallSign in
Socket

@aml-org/ruleset-development-cli

Package Overview
Dependencies
Maintainers
11
Versions
63
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aml-org/ruleset-development-cli

Tooling to design, test and publish AMF rulesets

Source
npmnpm
Version
0.1.0
Version published
Weekly downloads
160
566.67%
Maintainers
11
Weekly downloads
 
Created
Source

oclif-hello-world

oclif example Hello World CLI

oclif Version CircleCI Downloads/week License

  • Usage
  • Commands

Usage

$ npm install -g @aml-org/ruleset-development-cli
$ ruleset-development-cli COMMAND
running command...
$ ruleset-development-cli (--version)
@aml-org/ruleset-development-cli/0.1.0 darwin-x64 node-v16.15.1
$ ruleset-development-cli --help [COMMAND]
USAGE
  $ ruleset-development-cli COMMAND
...

Commands

ruleset-development-cli build [FILE]

generates a consolidated ruleset file with all the rules

USAGE
  $ ruleset-development-cli build [FILE] [-l <value>]

FLAGS
  -l, --location=<value>  path where the project will be created

DESCRIPTION
  generates a consolidated ruleset file with all the rules

EXAMPLES
  $ ruleset-development-cli build

See code: dist/commands/build.ts

ruleset-development-cli clean [FILE]

cleans debug and model data

USAGE
  $ ruleset-development-cli clean [FILE] [-l <value>]

FLAGS
  -l, --location=<value>  path where the project will be created

DESCRIPTION
  cleans debug and model data

EXAMPLES
  $ ruleset-development-cli clean

See code: dist/commands/clean.ts

ruleset-development-cli help [COMMAND]

Display help for ruleset-development-cli.

USAGE
  $ ruleset-development-cli help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

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

DESCRIPTION
  Display help for ruleset-development-cli.

See code: @oclif/plugin-help

ruleset-development-cli lint

Validates the rules syntax without testing any examples

USAGE
  $ ruleset-development-cli lint [-l <value>]

FLAGS
  -l, --location=<value>  path where the project will be created

DESCRIPTION
  Validates the rules syntax without testing any examples

EXAMPLES
  $ ruleset-development-cli lint

See code: dist/commands/lint.ts

ruleset-development-cli model dump

serializes the JSON-LD model for an example

USAGE
  $ ruleset-development-cli model dump [-l <value>] [-f <value>]

FLAGS
  -f, --filter=<value>    regex used to filter the examples that are going to be validated
  -l, --location=<value>  path where the project will be created

DESCRIPTION
  serializes the JSON-LD model for an example

EXAMPLES
  $ ruleset-development-cli model dump

ruleset-development-cli new NAME

Generates a new ruleset project

USAGE
  $ ruleset-development-cli new [NAME] [-l <value>]

ARGUMENTS
  NAME  name of the ruleset

FLAGS
  -l, --location=<value>  path where the project will be created

DESCRIPTION
  Generates a new ruleset project

EXAMPLES
  $ ruleset-development-cli new

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

ruleset-development-cli new example RULENAME ID

generates a new example for a rule

USAGE
  $ ruleset-development-cli new example [RULENAME] [ID] [-f <value>] [-l <value>] [-o <value>]

ARGUMENTS
  RULENAME  name of the rule where the example will be added
  ID        id of the example

FLAGS
  -f, --format=<value>    spec format for the example (oas, raml, asyncapi, graphql, grpc)
  -l, --location=<value>  path where the project will be created
  -o, --only=<value>      generate only positive|negative example

DESCRIPTION
  generates a new example for a rule

EXAMPLES
  $ ruleset-development-cli new example

ruleset-development-cli new rule NAME

creates a new rule for the ruleset

USAGE
  $ ruleset-development-cli new rule [NAME] [-s <value>] [-m <value>] [-l <value>]

ARGUMENTS
  NAME  name of the rule

FLAGS
  -l, --location=<value>  path where the project will be created
  -m, --message=<value>   error message for the rule
  -s, --level=<value>     severity level for the rule

DESCRIPTION
  creates a new rule for the ruleset

EXAMPLES
  $ ruleset-development-cli new rule

ruleset-development-cli plugins

List installed plugins.

USAGE
  $ ruleset-development-cli plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ruleset-development-cli plugins

See code: @oclif/plugin-plugins

ruleset-development-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ ruleset-development-cli 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
  $ ruleset-development-cli plugins add

EXAMPLES
  $ ruleset-development-cli plugins:install myplugin 

  $ ruleset-development-cli plugins:install https://github.com/someuser/someplugin

  $ ruleset-development-cli plugins:install someuser/someplugin

ruleset-development-cli plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ ruleset-development-cli plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ ruleset-development-cli plugins:inspect myplugin

ruleset-development-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ ruleset-development-cli 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
  $ ruleset-development-cli plugins add

EXAMPLES
  $ ruleset-development-cli plugins:install myplugin 

  $ ruleset-development-cli plugins:install https://github.com/someuser/someplugin

  $ ruleset-development-cli plugins:install someuser/someplugin

Links a plugin into the CLI for development.

USAGE
  $ ruleset-development-cli 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
  $ ruleset-development-cli plugins:link myplugin

ruleset-development-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ruleset-development-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ruleset-development-cli plugins unlink
  $ ruleset-development-cli plugins remove

ruleset-development-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ruleset-development-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ruleset-development-cli plugins unlink
  $ ruleset-development-cli plugins remove

ruleset-development-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ruleset-development-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ruleset-development-cli plugins unlink
  $ ruleset-development-cli plugins remove

ruleset-development-cli plugins update

Update installed plugins.

USAGE
  $ ruleset-development-cli plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

ruleset-development-cli test

Lints the rules syntax and test all the rule examples

USAGE
  $ ruleset-development-cli test [-l <value>] [-f <value>] [-d] [-s]

FLAGS
  -d, --debug             generates debug output for the example being tested
  -f, --filter=<value>    regex used to filter the examples that are going to be validated
  -l, --location=<value>  path where the project will be created
  -s, --skipLinting       does not lint the rulesets before running the tests

DESCRIPTION
  Lints the rules syntax and test all the rule examples

EXAMPLES
  $ ruleset-development-cli test

See code: dist/commands/test.ts

Keywords

oclif

FAQs

Package last updated on 13 Sep 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts