This package has been deprecated

Author message:

This package is no longer in use. Please see @communities-webruntime/cli

@webruntime/cli

Usage

$ npm install -g @webruntime/cli
$ webruntime COMMAND
running command...
$ webruntime (-v|--version|version)
@webruntime/cli/0.18.34 ${process.platform} ${process.version}
$ webruntime --help [COMMAND]
USAGE
  $ webruntime COMMAND
...

Commands

• webruntime generate [TEMPLATEDIR] [DESCRIPTOR]
• webruntime run [TEMPLATEDIR]
• webruntime validate [TEMPLATEDIR]

webruntime generate [TEMPLATEDIR] [DESCRIPTOR]

Generate the template resources

USAGE
  $ webruntime generate [TEMPLATEDIR] [DESCRIPTOR]

ARGUMENTS
  TEMPLATEDIR  [default: .] The template root directory
  DESCRIPTOR   The descriptor of the resource to generate e.g. component://x/cmp1@fr

OPTIONS
  --experimentalContainer              Compile the template using experimental Container runtime
  --filter=filter                      A regular expression used to filter the resources to generate
  --isDesignMode                       Compile the template for usage in design mode
  --isPreview                          Compile the template for usage in preview
  --labels=labels                      The labels.json file path
  --locale=locale                      The locale to use

  --modes=modes                        A comma separated list of modes in which the resources will be generated,
                                       defaults to all modes (dev, compat, prod, prod_compat)

  --outputDir=outputDir                Output dir where resources will be written

  --partials=partials                  Directory where handlebar partials are stored to be used in templates

  --routes=routes                      The routes.json file path

  --runInBand                          Avoid forking the compiler workers

  --srcDir=srcDir                      Source directory, used to compute the template version key

  --theme=theme                        The theme.json file path

  --views=views                        Where to get the view metadata from

  --webruntimeConfig=webruntimeConfig  The webruntime.config.json file path

webruntime run [TEMPLATEDIR]

Start the server

USAGE
  $ webruntime run [TEMPLATEDIR]

ARGUMENTS
  TEMPLATEDIR  [default: .] The template root directory

OPTIONS
  --apiEndpoint=apiEndpoint            The external API endpoint to proxy API calls to. If not specified, replay mode
                                       will be used

  --basePath=basePath                  The base path from which the web application will be served, defaults to '/'

  --experimentalContainer              Compile the template using experimental Container runtime

  --indexHtml=indexHtml                The index.html file path

  --isDesignMode                       Compile the template for usage in design mode

  --isPreview                          Compile the template for usage in preview

  --labels=labels                      The labels.json file path

  --locale=locale                      The locale to use

  --modes=modes                        A comma separated list of modes in which the resources will be generated,
                                       defaults to all modes (dev, compat, prod, prod_compat)

  --outputDir=outputDir                Output dir where resources will be written

  --partials=partials                  Directory where handlebar partials are stored to be used in templates

  --port=port                          [default: 3000] The server port

  --recordApiCalls                     Whether proxied API calls responses should be recorded

  --routes=routes                      The routes.json file path

  --runInBand                          Avoid forking the compiler workers

  --srcDir=srcDir                      Source directory, used to compute the template version key

  --theme=theme                        The theme.json file path

  --views=views                        Where to get the view metadata from

  --webruntimeConfig=webruntimeConfig  The webruntime.config.json file path

webruntime validate [TEMPLATEDIR]

Validate the template metadata

USAGE
  $ webruntime validate [TEMPLATEDIR]

ARGUMENTS
  TEMPLATEDIR  [default: .] The template root directory

OPTIONS
  --labels=labels  The labels.json file path
  --routes=routes  The routes.json file path
  --theme=theme    The theme.json file path
  --views=views    Where to get the view metadata from