@springmicro/cli v0.5.16

@springmicro/cli

Command line utilities for SpringMicroHost.

• @springmicro/cli
• Usage
• Commands
• Development

Usage

$ npm install -g @springmicro/cli
$ springmicro COMMAND
running command...
$ springmicro (--version)
@springmicro/cli/0.5.16 linux-x64 node-v22.12.0
$ springmicro --help [COMMAND]
USAGE
  $ springmicro COMMAND
...

Commands

• springmicro add auth
• springmicro add form
• springmicro help [COMMAND]
• springmicro init PROJECTTYPE
• springmicro init astro
• springmicro plugins
• springmicro plugins add PLUGIN
• springmicro plugins:inspect PLUGIN...
• springmicro plugins install PLUGIN
• springmicro plugins link PATH
• springmicro plugins remove [PLUGIN]
• springmicro plugins reset
• springmicro plugins uninstall [PLUGIN]
• springmicro plugins unlink [PLUGIN]
• springmicro plugins update

springmicro add auth

describe the command here

USAGE
  $ springmicro add auth

DESCRIPTION
  describe the command here

EXAMPLES
  $ springmicro add auth

See code: src/commands/add/auth.ts

springmicro add form

add a form to your project

USAGE
  $ springmicro add form [-t <value>]

FLAGS
  -t, --template=<value>  form template (contact|quote)

DESCRIPTION
  add a form to your project

EXAMPLES
  $ springmicro add form

See code: src/commands/add/form.ts

springmicro help [COMMAND]

Display help for springmicro.

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

See code: @oclif/plugin-help

springmicro init PROJECTTYPE

Initialize a JavaScript framework project according to SpringMicroHost's specifications.

USAGE
  $ springmicro init PROJECTTYPE -n <value>

ARGUMENTS
  PROJECTTYPE  Project type (astro)

FLAGS
  -n, --name=<value>  (required) Project name

DESCRIPTION
  Initialize a JavaScript framework project according to SpringMicroHost's specifications.

EXAMPLES
  $ springmicro init astro -n example

See code: src/commands/init/index.ts

springmicro init astro

Initialize a Astro project according to SpringMicroHost's specifications.

USAGE
  $ springmicro init astro -n <value>

FLAGS
  -n, --name=<value>  (required) Project name

DESCRIPTION
  Initialize a Astro project according to SpringMicroHost's specifications.

EXAMPLES
  $ springmicro init astro -n <project-name>

See code: src/commands/init/astro.ts

springmicro plugins

List installed plugins.

USAGE
  $ springmicro plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ springmicro plugins

See code: @oclif/plugin-plugins

springmicro plugins add PLUGIN

Installs a plugin into springmicro.

USAGE
  $ springmicro plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into springmicro.

  Uses npm to install plugins.

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

  Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ springmicro plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ springmicro plugins add myplugin

  Install a plugin from a github url.

    $ springmicro plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ springmicro plugins add someuser/someplugin

springmicro plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ springmicro 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
  $ springmicro plugins inspect myplugin

See code: @oclif/plugin-plugins

springmicro plugins install PLUGIN

Installs a plugin into springmicro.

USAGE
  $ springmicro plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into springmicro.

  Uses npm to install plugins.

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

  Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ springmicro plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ springmicro plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ springmicro plugins install someuser/someplugin

See code: @oclif/plugin-plugins

springmicro plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ springmicro plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

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
  $ springmicro plugins link myplugin

See code: @oclif/plugin-plugins

springmicro plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ springmicro plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ springmicro plugins unlink
  $ springmicro plugins remove

EXAMPLES
  $ springmicro plugins remove myplugin

springmicro plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ springmicro plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

springmicro plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ springmicro plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ springmicro plugins unlink
  $ springmicro plugins remove

EXAMPLES
  $ springmicro plugins uninstall myplugin

See code: @oclif/plugin-plugins

springmicro plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ springmicro plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ springmicro plugins unlink
  $ springmicro plugins remove

EXAMPLES
  $ springmicro plugins unlink myplugin

springmicro plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

Development

See https://oclif.io/docs/templates for details about running the CLI in development.

The generated CLI project contains 4 bin scripts that you can use for either production or development.

• bin/run.js - Run the CLI in production (macOS and Linux)
• bin/dev.js - Run the CLI in development (macOS and Linux)
• bin/run.cmd - Run the CLI in production (Windows)
• bin/dev.cmd - Run the CLI in development (Windows)