@springmicro/cli 0.2.0-alpha.3 → 0.2.0

package/README.md

@@ -12,6 +12,11 @@ Command line utilities for SpringMicroHost.
 * [Commands](#commands)
 * [Development](#development)
 <!-- tocstop -->
+* [@springmicro/cli](#springmicrocli)
+* [Usage](#usage)
+* [Commands](#commands)
+* [Development](#development)
+<!-- tocstop -->
 
 - [@springmicro/cli](#springmicrocli)
 - [Usage](#usage)
@@ -26,13 +31,25 @@ $ npm install -g @springmicro/cli
 $ springmicro COMMAND
 running command...
 $ springmicro (--version)
-@springmicro/cli/0.2.0-alpha.3 win32-x64 node-v20.15.0
+@springmicro/cli/0.2.0 win32-x64 node-v20.15.0
 $ springmicro --help [COMMAND]
 USAGE
   $ springmicro COMMAND
 ...
 ```
 <!-- usagestop -->
+```sh-session
+$ npm install -g @springmicro/cli
+$ springmicro COMMAND
+running command...
+$ springmicro (--version)
+@springmicro/cli/0.2.0-alpha.3 win32-x64 node-v20.15.0
+$ springmicro --help [COMMAND]
+USAGE
+  $ springmicro COMMAND
+...
+```
+<!-- usagestop -->
 
 ```sh-session
 $ npm install -g @springmicro/cli
@@ -81,7 +98,7 @@ EXAMPLES
   $ springmicro add auth
 ```
 
-_See code: [src/commands/add/auth.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.3/src/commands/add/auth.ts)_
+_See code: [src/commands/add/auth.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0/src/commands/add/auth.ts)_
 
 ## `springmicro help [COMMAND]`
 
@@ -101,7 +118,7 @@ DESCRIPTION
   Display help for springmicro.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.5/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.7/src/commands/help.ts)_
 
 ## `springmicro init PROJECTTYPE`
 
@@ -124,7 +141,7 @@ EXAMPLES
   $ springmicro init astro -n example
 ```
 
-_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.3/src/commands/init/index.ts)_
+_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0/src/commands/init/index.ts)_
 
 ## `springmicro init astro`
 
@@ -144,7 +161,7 @@ EXAMPLES
   $ springmicro init astro -n <project-name>
 ```
 
-_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.3/src/commands/init/astro.ts)_
+_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0/src/commands/init/astro.ts)_
 
 ## `springmicro plugins`
 
@@ -167,7 +184,7 @@ EXAMPLES
   $ springmicro plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.4/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.9/src/commands/plugins/index.ts)_
 
 ## `springmicro plugins add PLUGIN`
 
@@ -241,7 +258,7 @@ EXAMPLES
   $ springmicro plugins inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.4/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.9/src/commands/plugins/inspect.ts)_
 
 ## `springmicro plugins install PLUGIN`
 
@@ -290,7 +307,7 @@ EXAMPLES
     $ springmicro plugins install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.4/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.9/src/commands/plugins/install.ts)_
 
 ## `springmicro plugins link PATH`
 
@@ -320,7 +337,7 @@ EXAMPLES
   $ springmicro plugins link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.4/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.9/src/commands/plugins/link.ts)_
 
 ## `springmicro plugins remove [PLUGIN]`
 
@@ -361,7 +378,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.4/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.9/src/commands/plugins/reset.ts)_
 
 ## `springmicro plugins uninstall [PLUGIN]`
 
@@ -389,7 +406,7 @@ EXAMPLES
   $ springmicro plugins uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.4/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.9/src/commands/plugins/uninstall.ts)_
 
 ## `springmicro plugins unlink [PLUGIN]`
 
@@ -433,7 +450,391 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.4/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.9/src/commands/plugins/update.ts)_
+<!-- commandsstop -->
+* [`springmicro add auth`](#springmicro-add-auth)
+* [`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.2.0-alpha.3/src/commands/add/auth.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.5/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.2.0-alpha.3/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.2.0-alpha.3/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.3.4/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.3.4/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.3.4/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.3.4/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.3.4/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.3.4/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.3.4/src/commands/plugins/update.ts)_
 <!-- commandsstop -->
 
 - [`springmicro help [COMMAND]`](#springmicro-help-command)

package/oclif.manifest.json

@@ -101,5 +101,5 @@
       ]
     }
   },
-  "version": "0.2.0-alpha.3"
+  "version": "0.2.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@springmicro/cli",
   "description": "A new CLI generated with oclif",
-  "version": "0.2.0-alpha.3",
+  "version": "0.2.0",
   "author": "David Buckley",
   "private": false,
   "publishConfig": {
@@ -76,5 +76,5 @@
     "version": "oclif readme && git add README.md"
   },
   "types": "dist/index.d.ts",
-  "gitHead": "0854b518932e657d4c08fb5877c725a9425b36e9"
+  "gitHead": "bada90b1f5c1efcd122b4a69436098408162677c"
 }