@springmicro/cli 0.5.1 → 0.5.2

package/README.md

@@ -1,36 +1,53 @@
-# @springmicro/cli
-
-Command line utilities for SpringMicroHost.
-
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/@springmicro/cli.svg)](https://npmjs.org/package/@springmicro/cli)
-[![Downloads/week](https://img.shields.io/npm/dw/@springmicro/cli.svg)](https://npmjs.org/package/@springmicro/cli)
-
+# @springmicro/cli
+
+Command line utilities for SpringMicroHost.
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@springmicro/cli.svg)](https://npmjs.org/package/@springmicro/cli)
+[![Downloads/week](https://img.shields.io/npm/dw/@springmicro/cli.svg)](https://npmjs.org/package/@springmicro/cli)
+
 <!-- toc -->
 * [@springmicro/cli](#springmicrocli)
 * [Usage](#usage)
 * [Commands](#commands)
 * [Development](#development)
-<!-- tocstop -->
-
-# Usage
-
+<!-- tocstop -->
+* [@springmicro/cli](#springmicrocli)
+* [Usage](#usage)
+* [Commands](#commands)
+* [Development](#development)
+<!-- tocstop -->
+
+# Usage
+
 <!-- usage -->
 ```sh-session
 $ npm install -g @springmicro/cli
 $ springmicro COMMAND
 running command...
 $ springmicro (--version)
-@springmicro/cli/0.5.1 linux-x64 node-v22.14.0
+@springmicro/cli/0.5.2 win32-x64 node-v18.20.4
 $ springmicro --help [COMMAND]
 USAGE
   $ springmicro COMMAND
 ...
 ```
-<!-- usagestop -->
-
-# Commands
-
+<!-- usagestop -->
+```sh-session
+$ npm install -g @springmicro/cli
+$ springmicro COMMAND
+running command...
+$ springmicro (--version)
+@springmicro/cli/0.5.0 linux-x64 node-v22.11.0
+$ springmicro --help [COMMAND]
+USAGE
+  $ springmicro COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
 <!-- commands -->
 * [`springmicro add auth`](#springmicro-add-auth)
 * [`springmicro add form`](#springmicro-add-form)
@@ -63,7 +80,7 @@ EXAMPLES
   $ springmicro add auth
 ```
 
-_See code: [src/commands/add/auth.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.1/src/commands/add/auth.ts)_
+_See code: [src/commands/add/auth.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.2/src/commands/add/auth.ts)_
 
 ## `springmicro add form`
 
@@ -83,7 +100,7 @@ EXAMPLES
   $ springmicro add form
 ```
 
-_See code: [src/commands/add/form.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.1/src/commands/add/form.ts)_
+_See code: [src/commands/add/form.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.2/src/commands/add/form.ts)_
 
 ## `springmicro help [COMMAND]`
 
@@ -126,7 +143,7 @@ EXAMPLES
   $ springmicro init astro -n example
 ```
 
-_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.1/src/commands/init/index.ts)_
+_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.2/src/commands/init/index.ts)_
 
 ## `springmicro init astro`
 
@@ -146,7 +163,7 @@ EXAMPLES
   $ springmicro init astro -n <project-name>
 ```
 
-_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.1/src/commands/init/astro.ts)_
+_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.2/src/commands/init/astro.ts)_
 
 ## `springmicro plugins`
 
@@ -437,15 +454,421 @@ DESCRIPTION
 ```
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/update.ts)_
-<!-- commandsstop -->
-
-# Development
-
-See [https://oclif.io/docs/templates](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)
+<!-- commandsstop -->
+* [`springmicro add auth`](#springmicro-add-auth)
+* [`springmicro add form`](#springmicro-add-form)
+* [`springmicro help [COMMAND]`](#springmicro-help-command)
+* [`springmicro init PROJECTTYPE`](#springmicro-init-projecttype)
+* [`springmicro init astro`](#springmicro-init-astro)
+* [`springmicro plugins`](#springmicro-plugins)
+* [`springmicro plugins add PLUGIN`](#springmicro-plugins-add-plugin)
+* [`springmicro plugins:inspect PLUGIN...`](#springmicro-pluginsinspect-plugin)
+* [`springmicro plugins install PLUGIN`](#springmicro-plugins-install-plugin)
+* [`springmicro plugins link PATH`](#springmicro-plugins-link-path)
+* [`springmicro plugins remove [PLUGIN]`](#springmicro-plugins-remove-plugin)
+* [`springmicro plugins reset`](#springmicro-plugins-reset)
+* [`springmicro plugins uninstall [PLUGIN]`](#springmicro-plugins-uninstall-plugin)
+* [`springmicro plugins unlink [PLUGIN]`](#springmicro-plugins-unlink-plugin)
+* [`springmicro plugins update`](#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](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.0/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](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.0/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](https://github.com/oclif/plugin-help/blob/v6.2.18/src/commands/help.ts)_
+
+## `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](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.0/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](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.5.0/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](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/index.ts)_
+
+## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/inspect.ts)_
+
+## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/install.ts)_
+
+## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/link.ts)_
+
+## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/reset.ts)_
+
+## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/uninstall.ts)_
+
+## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/update.ts)_
+<!-- commandsstop -->
+
+# Development
+
+See [https://oclif.io/docs/templates](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)

package/bin/dev.cmd

@@ -1,3 +1,3 @@
-@echo off
-
-node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -1,6 +1,6 @@
-#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
-
-// eslint-disable-next-line n/shebang
-import {execute} from '@oclif/core'
-
-await execute({development: true, dir: import.meta.url})
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+// eslint-disable-next-line n/shebang
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -1,3 +1,3 @@
-@echo off
-
-node "%~dp0\run" %*
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -1,5 +1,5 @@
-#!/usr/bin/env node
-
-import {execute} from '@oclif/core'
-
-await execute({dir: import.meta.url})
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})