@liquidmetal-ai/raindrop 0.0.0

package/README.md

@@ -0,0 +1,777 @@
+# raindrop
+
+CLI for the Raindrop platform
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/raindrop.svg)](https://npmjs.org/package/raindrop)
+[![Downloads/week](https://img.shields.io/npm/dw/raindrop.svg)](https://npmjs.org/package/raindrop)
+
+<!-- toc -->
+* [raindrop](#raindrop)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+
+You will need to have the monorepo setup and initialized.
+
+From the root of the monorepo:
+
+```sh-session
+$ npm install
+...
+```
+
+<!-- usage -->
+```sh-session
+$ npm install -g @liquidmetal-ai/raindrop
+$ raindrop COMMAND
+running command...
+$ raindrop (--version)
+@liquidmetal-ai/raindrop/0.0.0 darwin-arm64 node-v22.10.0
+$ raindrop --help [COMMAND]
+USAGE
+  $ raindrop COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+* [`raindrop auth list`](#raindrop-auth-list)
+* [`raindrop auth login`](#raindrop-auth-login)
+* [`raindrop auth logout`](#raindrop-auth-logout)
+* [`raindrop auth select`](#raindrop-auth-select)
+* [`raindrop build branch`](#raindrop-build-branch)
+* [`raindrop build delete [APPLICATION]`](#raindrop-build-delete-application)
+* [`raindrop build deploy`](#raindrop-build-deploy)
+* [`raindrop build env get VAR`](#raindrop-build-env-get-var)
+* [`raindrop build env set VAR [VALUE]`](#raindrop-build-env-set-var-value)
+* [`raindrop build find`](#raindrop-build-find)
+* [`raindrop build generate`](#raindrop-build-generate)
+* [`raindrop build init [PATH]`](#raindrop-build-init-path)
+* [`raindrop build list`](#raindrop-build-list)
+* [`raindrop build start`](#raindrop-build-start)
+* [`raindrop build stop`](#raindrop-build-stop)
+* [`raindrop build token`](#raindrop-build-token)
+* [`raindrop build upload`](#raindrop-build-upload)
+* [`raindrop build validate`](#raindrop-build-validate)
+* [`raindrop help [COMMAND]`](#raindrop-help-command)
+* [`raindrop plugins`](#raindrop-plugins)
+* [`raindrop plugins add PLUGIN`](#raindrop-plugins-add-plugin)
+* [`raindrop plugins:inspect PLUGIN...`](#raindrop-pluginsinspect-plugin)
+* [`raindrop plugins install PLUGIN`](#raindrop-plugins-install-plugin)
+* [`raindrop plugins link PATH`](#raindrop-plugins-link-path)
+* [`raindrop plugins remove [PLUGIN]`](#raindrop-plugins-remove-plugin)
+* [`raindrop plugins reset`](#raindrop-plugins-reset)
+* [`raindrop plugins uninstall [PLUGIN]`](#raindrop-plugins-uninstall-plugin)
+* [`raindrop plugins unlink [PLUGIN]`](#raindrop-plugins-unlink-plugin)
+* [`raindrop plugins update`](#raindrop-plugins-update)
+
+## `raindrop auth list`
+
+List authentications
+
+```
+USAGE
+  $ raindrop auth list [-o text|table|json]
+
+FLAGS
+  -o, --output=<option>  [default: table] output format
+                         <options: text|table|json>
+
+DESCRIPTION
+  List authentications
+```
+
+_See code: [src/commands/auth/list.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/auth/list.ts)_
+
+## `raindrop auth login`
+
+Logs a user into the LiquidMetal platform. Supports browser-based authentication.
+
+```
+USAGE
+  $ raindrop auth login
+
+DESCRIPTION
+  Logs a user into the LiquidMetal platform. Supports browser-based authentication.
+```
+
+_See code: [src/commands/auth/login.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/auth/login.ts)_
+
+## `raindrop auth logout`
+
+Logout authentications
+
+```
+USAGE
+  $ raindrop auth logout
+
+DESCRIPTION
+  Logout authentications
+```
+
+_See code: [src/commands/auth/logout.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/auth/logout.ts)_
+
+## `raindrop auth select`
+
+Select active organization
+
+```
+USAGE
+  $ raindrop auth select [--organizationId <value>]
+
+FLAGS
+  --organizationId=<value>  organizationId to select as active
+
+DESCRIPTION
+  Select active organization
+```
+
+_See code: [src/commands/auth/select.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/auth/select.ts)_
+
+## `raindrop build branch`
+
+create a new branch in the Raindrop catalog
+
+```
+USAGE
+  $ raindrop build branch [-p <value> | -s <value>] [--manifest <value>]
+
+FLAGS
+  -p, --previousVersionId=<value>  previous version ID
+  -s, --select=<value>             select a specific version ID
+      --manifest=<value>           [default: raindrop.manifest] project manifest
+
+DESCRIPTION
+  create a new branch in the Raindrop catalog
+
+EXAMPLES
+  $ raindrop build branch .
+  Create a new branch in the Raindrop catalog.
+```
+
+_See code: [src/commands/build/branch.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/branch.ts)_
+
+## `raindrop build delete [APPLICATION]`
+
+delete Raindrop applications
+
+```
+USAGE
+  $ raindrop build delete [APPLICATION] [-o text|table|json] [-v <value> | -a] [--manifest <value>]
+
+ARGUMENTS
+  APPLICATION  application name
+
+FLAGS
+  -a, --all               delete all application versions
+  -o, --output=<option>   [default: table] output format
+                          <options: text|table|json>
+  -v, --version=<value>   application version to delete
+      --manifest=<value>  [default: raindrop.manifest] project manifest
+
+DESCRIPTION
+  delete Raindrop applications
+
+EXAMPLES
+  $ raindrop build delete .
+  Deleted (application) at version (version)
+```
+
+_See code: [src/commands/build/delete.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/delete.ts)_
+
+## `raindrop build deploy`
+
+deploy a Raindrop application
+
+```
+USAGE
+  $ raindrop build deploy [-r <value>] [-m <value>] [-o <value>] [-v <value>] [-s]
+
+FLAGS
+  -m, --manifest=<value>   [default: raindrop.manifest] project manifest
+  -o, --output=<value>     [default: dist] output directory
+  -r, --root=<value>       [default: /Users/ian/liquidmetal/packages/raindrop] root directory
+  -s, --start              start the application after deploying
+  -v, --versionId=<value>  version ID
+
+DESCRIPTION
+  deploy a Raindrop application
+
+EXAMPLES
+  $ raindrop build deploy .
+  Deploy a Raindrop application.
+```
+
+_See code: [src/commands/build/deploy.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/deploy.ts)_
+
+## `raindrop build env get VAR`
+
+get an env var/secret
+
+```
+USAGE
+  $ raindrop build env get VAR [-o <value>] [-m <value>] [-v <value>] [-a <value>] [-c <value>]
+
+ARGUMENTS
+  VAR  env var/secret name
+
+FLAGS
+  -a, --application=<value>  application
+  -c, --config=<value>       [default: .raindrop/config.json] config file
+  -m, --manifest=<value>     [default: raindrop.manifest] project manifest
+  -o, --output=<value>       [default: table] output format
+  -v, --versionId=<value>    version ID
+
+DESCRIPTION
+  get an env var/secret
+
+EXAMPLES
+  $ raindrop build env get my-app:env:MY_VAR
+  sets an env var/secret.
+```
+
+_See code: [src/commands/build/env/get.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/env/get.ts)_
+
+## `raindrop build env set VAR [VALUE]`
+
+set an env var/secret
+
+```
+USAGE
+  $ raindrop build env set VAR [VALUE] [-o <value>] [-m <value>] [-v <value>] [-a <value>] [-c <value>]
+
+ARGUMENTS
+  VAR    env var/secret name
+  VALUE  env var/secret value
+
+FLAGS
+  -a, --application=<value>  application to start
+  -c, --config=<value>       [default: .raindrop/config.json] config file
+  -m, --manifest=<value>     [default: raindrop.manifest] project manifest
+  -o, --output=<value>       [default: table] output format
+  -v, --versionId=<value>    version ID
+
+DESCRIPTION
+  set an env var/secret
+
+EXAMPLES
+  $ raindrop build env set .
+  sets an env var/secret.
+```
+
+_See code: [src/commands/build/env/set.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/env/set.ts)_
+
+## `raindrop build find`
+
+find resources in Raindrop
+
+```
+USAGE
+  $ raindrop build find [-a <value>] [-v <value>] [-o text|table|json] [--manifest <value>]
+
+FLAGS
+  -a, --application=<value>  application
+  -o, --output=<option>      [default: table] output format
+                             <options: text|table|json>
+  -v, --version=<value>      application version
+      --manifest=<value>     [default: raindrop.manifest] project manifest
+
+DESCRIPTION
+  find resources in Raindrop
+
+EXAMPLES
+  $ raindrop build find .
+```
+
+_See code: [src/commands/build/find.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/find.ts)_
+
+## `raindrop build generate`
+
+(re)generate all code for a LiquidMetal.AI project
+
+```
+USAGE
+  $ raindrop build generate [-r <value>] [-m <value>] [-o <value>]
+
+FLAGS
+  -m, --manifest=<value>  [default: raindrop.manifest] manifest file
+  -o, --output=<value>    [default: dist] output directory
+  -r, --root=<value>      [default: /Users/ian/liquidmetal/packages/raindrop] root directory
+
+DESCRIPTION
+  (re)generate all code for a LiquidMetal.AI project
+
+EXAMPLES
+  $ raindrop build generate
+```
+
+_See code: [src/commands/build/generate.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/generate.ts)_
+
+## `raindrop build init [PATH]`
+
+start a new LiquidMetal.AI project
+
+```
+USAGE
+  $ raindrop build init [PATH] [--overwrite]
+
+ARGUMENTS
+  PATH  [default: .] Path to initialize the project in
+
+FLAGS
+  --overwrite  Overwrite existing files
+
+DESCRIPTION
+  start a new LiquidMetal.AI project
+
+EXAMPLES
+  $ raindrop build init .
+  Initialize a project in the current directory.
+```
+
+_See code: [src/commands/build/init.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/init.ts)_
+
+## `raindrop build list`
+
+list Raindrop catalog resources
+
+```
+USAGE
+  $ raindrop build list [-t <value>] [-a] [-o text|table|json]
+
+FLAGS
+  -a, --all              show even deleted resources
+  -o, --output=<option>  [default: table] output format
+                         <options: text|table|json>
+  -t, --type=<value>     [default: application] resource type
+
+DESCRIPTION
+  list Raindrop catalog resources
+
+EXAMPLES
+  $ raindrop build list .
+  List Raindrop catalog resources.
+```
+
+_See code: [src/commands/build/list.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/list.ts)_
+
+## `raindrop build start`
+
+start a Raindrop application
+
+```
+USAGE
+  $ raindrop build start [-c <value>] [-m <value>] [-a <value>] [-v <value>]
+
+FLAGS
+  -a, --application=<value>  application to start
+  -c, --config=<value>       [default: .raindrop/config.json] config file
+  -m, --manifest=<value>     [default: raindrop.manifest] project manifest
+  -v, --version=<value>      application version to start
+
+DESCRIPTION
+  start a Raindrop application
+
+EXAMPLES
+  $ raindrop build start .
+  Start a Raindrop application.
+```
+
+_See code: [src/commands/build/start.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/start.ts)_
+
+## `raindrop build stop`
+
+stop a Raindrop application
+
+```
+USAGE
+  $ raindrop build stop [-a <value>] [-v <value>]
+
+FLAGS
+  -a, --application=<value>  application to stop
+  -v, --version=<value>      application version to start
+
+DESCRIPTION
+  stop a Raindrop application
+
+EXAMPLES
+  $ raindrop build stop .
+  Stop a Raindrop application.
+```
+
+_See code: [src/commands/build/stop.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/stop.ts)_
+
+## `raindrop build token`
+
+generate a link to create a Cloudflare API token
+
+```
+USAGE
+  $ raindrop build token
+
+DESCRIPTION
+  generate a link to create a Cloudflare API token
+```
+
+_See code: [src/commands/build/token.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/token.ts)_
+
+## `raindrop build upload`
+
+build and validate a LiquidMetal.AI project
+
+```
+USAGE
+  $ raindrop build upload -v <value> [-r <value>] [-m <value>] [-c <value>] [-o <value>]
+
+FLAGS
+  -c, --config=<value>     [default: .raindrop/config.json] config file
+  -m, --manifest=<value>   [default: raindrop.manifest] project manifest
+  -o, --output=<value>     [default: dist] output directory
+  -r, --root=<value>       [default: /Users/ian/liquidmetal/packages/raindrop] root directory
+  -v, --versionId=<value>  (required) version ID
+
+DESCRIPTION
+  build and validate a LiquidMetal.AI project
+
+EXAMPLES
+  $ raindrop build upload
+```
+
+_See code: [src/commands/build/upload.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/upload.ts)_
+
+## `raindrop build validate`
+
+build and validate a LiquidMetal.AI project
+
+```
+USAGE
+  $ raindrop build validate [-r <value>] [-m <value>] [-o <value>]
+
+FLAGS
+  -m, --manifest=<value>  [default: raindrop.manifest] project manifest
+  -o, --output=<value>    [default: dist] output directory
+  -r, --root=<value>      [default: /Users/ian/liquidmetal/packages/raindrop] root directory
+
+DESCRIPTION
+  build and validate a LiquidMetal.AI project
+
+EXAMPLES
+  $ raindrop build validate
+```
+
+_See code: [src/commands/build/validate.ts](https://github.com/liquidmetal-ai/liquidmetal/blob/v0.0.0/src/commands/build/validate.ts)_
+
+## `raindrop help [COMMAND]`
+
+Display help for raindrop.
+
+```
+USAGE
+  $ raindrop 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 raindrop.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.13/src/commands/help.ts)_
+
+## `raindrop plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ raindrop plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ raindrop plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/index.ts)_
+
+## `raindrop plugins add PLUGIN`
+
+Installs a plugin into raindrop.
+
+```
+USAGE
+  $ raindrop 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 raindrop.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the RAINDROP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the RAINDROP_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ raindrop plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ raindrop plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ raindrop plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ raindrop plugins add someuser/someplugin
+```
+
+## `raindrop plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ raindrop 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
+  $ raindrop plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/inspect.ts)_
+
+## `raindrop plugins install PLUGIN`
+
+Installs a plugin into raindrop.
+
+```
+USAGE
+  $ raindrop 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 raindrop.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the RAINDROP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the RAINDROP_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ raindrop plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ raindrop plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ raindrop plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ raindrop plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/install.ts)_
+
+## `raindrop plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ raindrop 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
+  $ raindrop plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/link.ts)_
+
+## `raindrop plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ raindrop 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
+  $ raindrop plugins unlink
+  $ raindrop plugins remove
+
+EXAMPLES
+  $ raindrop plugins remove myplugin
+```
+
+## `raindrop plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ raindrop 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.10/src/commands/plugins/reset.ts)_
+
+## `raindrop plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ raindrop 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
+  $ raindrop plugins unlink
+  $ raindrop plugins remove
+
+EXAMPLES
+  $ raindrop plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/uninstall.ts)_
+
+## `raindrop plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ raindrop 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
+  $ raindrop plugins unlink
+  $ raindrop plugins remove
+
+EXAMPLES
+  $ raindrop plugins unlink myplugin
+```
+
+## `raindrop plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ raindrop 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.10/src/commands/plugins/update.ts)_
+<!-- commandsstop -->