@twin.org/cli-core 0.0.1-next.1

package/docs/reference/classes/CLIDisplay.md

@@ -0,0 +1,259 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Class: CLIDisplay
+
+Display utilities for the CLI.
+
+## Constructors
+
+### new CLIDisplay()
+
+> **new CLIDisplay**(): [`CLIDisplay`](CLIDisplay.md)
+
+#### Returns
+
+[`CLIDisplay`](CLIDisplay.md)
+
+## Properties
+
+### write()
+
+> `static` **write**: (`buffer`) => `void`
+
+The default output method for writing standard messages.
+
+#### Parameters
+
+• **buffer**: `string` \| `Uint8Array`
+
+The message to output.
+
+#### Returns
+
+`void`
+
+***
+
+### writeError()
+
+> `static` **writeError**: (`buffer`) => `void`
+
+The default output method for writing error messages.
+
+#### Parameters
+
+• **buffer**: `string` \| `Uint8Array`
+
+The message to output.
+
+#### Returns
+
+`void`
+
+***
+
+### clearLine()
+
+> `static` **clearLine**: () => `void`
+
+The default output method for clearing the current line.
+
+#### Returns
+
+`void`
+
+## Methods
+
+### header()
+
+> `static` **header**(`title`, `version`, `icon`): `void`
+
+Display the header for the CLI.
+
+#### Parameters
+
+• **title**: `string`
+
+The title of the CLI.
+
+• **version**: `string`
+
+The version of the CLI.
+
+• **icon**: `string`
+
+The icon for the CLI.
+
+#### Returns
+
+`void`
+
+***
+
+### error()
+
+> `static` **error**(`error`, `lineBreaks`): `void`
+
+Display an error message.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to display.
+
+• **lineBreaks**: `boolean`= `true`
+
+Whether to add a line break after the error.
+
+#### Returns
+
+`void`
+
+***
+
+### section()
+
+> `static` **section**(`label`): `void`
+
+Display a section.
+
+#### Parameters
+
+• **label**: `string`
+
+The label for the section.
+
+#### Returns
+
+`void`
+
+***
+
+### value()
+
+> `static` **value**(`label`, `value`, `indentLevel`): `void`
+
+Display a value with a label.
+
+#### Parameters
+
+• **label**: `string`
+
+The label for the value.
+
+• **value**: `unknown`
+
+The value to display.
+
+• **indentLevel**: `number`= `0`
+
+The level of indentation.
+
+#### Returns
+
+`void`
+
+***
+
+### task()
+
+> `static` **task**(`label`, `task`?): `void`
+
+Display a task with a label.
+
+#### Parameters
+
+• **label**: `string`
+
+The label for the value.
+
+• **task?**: `string`
+
+The task to display.
+
+#### Returns
+
+`void`
+
+***
+
+### break()
+
+> `static` **break**(): `void`
+
+Display a break.
+
+#### Returns
+
+`void`
+
+***
+
+### json()
+
+> `static` **json**(`obj`): `void`
+
+Display formatted and colorized JSON.
+
+#### Parameters
+
+• **obj**: `unknown`
+
+The object to display.
+
+#### Returns
+
+`void`
+
+***
+
+### done()
+
+> `static` **done**(): `void`
+
+Display the processing is done.
+
+#### Returns
+
+`void`
+
+***
+
+### spinnerStart()
+
+> `static` **spinnerStart**(`i18nMessage`, `spinnerCharacters`, `interval`): `void`
+
+Start the spinner.
+
+#### Parameters
+
+• **i18nMessage**: `string`= `"cli.progress.pleaseWait"`
+
+The message to display with the spinner.
+
+• **spinnerCharacters**: `string`[]= `undefined`
+
+The characters to use in the spinner.
+
+• **interval**: `number`= `100`
+
+The interval for the spinner.
+
+#### Returns
+
+`void`
+
+***
+
+### spinnerStop()
+
+> `static` **spinnerStop**(): `void`
+
+Stop the spinner.
+
+#### Returns
+
+`void`

package/docs/reference/classes/CLIOptions.md

@@ -0,0 +1,59 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Class: CLIOptions
+
+Utilities for getting standard options.
+
+## Constructors
+
+### new CLIOptions()
+
+> **new CLIOptions**(): [`CLIOptions`](CLIOptions.md)
+
+#### Returns
+
+[`CLIOptions`](CLIOptions.md)
+
+## Methods
+
+### output()
+
+> `static` **output**(`command`, `opts`): `void`
+
+Get the options for output.
+
+#### Parameters
+
+• **command**: `Command`
+
+The command to add the options to.
+
+• **opts**
+
+The options of what to include.
+
+• **opts.noConsole**: `boolean`
+
+Do not output to the console.
+
+• **opts.json**: `boolean`
+
+Output to a JSON file.
+
+• **opts.env**: `boolean`
+
+Output to an environment file.
+
+• **opts.mergeJson**: `boolean`
+
+Merge existing JSON file.
+
+• **opts.mergeEnv**: `boolean`
+
+Merge existing environment file.
+
+#### Returns
+
+`void`

package/docs/reference/classes/CLIParam.md

@@ -0,0 +1,393 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Class: CLIParam
+
+Parameter utilities for the CLI.
+
+## Constructors
+
+### new CLIParam()
+
+> **new CLIParam**(): [`CLIParam`](CLIParam.md)
+
+#### Returns
+
+[`CLIParam`](CLIParam.md)
+
+## Methods
+
+### env()
+
+> `static` **env**(`optionName`, `optionValue`, `allowEnvVar`): `undefined` \| `string`
+
+Check the option to see if it exists.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`undefined` \| `string`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### stringValue()
+
+> `static` **stringValue**(`optionName`, `optionValue`, `allowEnvVar`): `string`
+
+Check the option to see if it exists.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`string`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### url()
+
+> `static` **url**(`optionName`, `optionValue`, `allowEnvVar`): `string`
+
+Check the option to see if it a url.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`string`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### number()
+
+> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `number`
+
+Check the option to see if it exists and is a number.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+• **minValue**: `number`= `0`
+
+The minimum value.
+
+• **maxValue?**: `number`
+
+The maximum value.
+
+#### Returns
+
+`number`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### integer()
+
+> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `number`
+
+Check the option to see if it exists and is an integer.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+• **minValue**: `number`= `0`
+
+The minimum value.
+
+• **maxValue?**: `number`
+
+The maximum value.
+
+#### Returns
+
+`number`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### bigint()
+
+> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `bigint`
+
+Check the option to see if it exists and is a big number.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+• **minValue**: `bigint`= `undefined`
+
+The minimum value.
+
+• **maxValue?**: `bigint`
+
+The maximum value.
+
+#### Returns
+
+`bigint`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### boolean()
+
+> `static` **boolean**(`optionName`, `optionValue`, `allowEnvVar`): `boolean`
+
+Check the option to see if it exists and is a boolean.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`boolean`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### hex()
+
+> `static` **hex**(`optionName`, `optionValue`, `allowEnvVar`): `Uint8Array`
+
+Check the option to see if it exists and is hex.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`Uint8Array`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### base64()
+
+> `static` **base64**(`optionName`, `optionValue`, `allowEnvVar`): `Uint8Array`
+
+Check the option to see if it exists and is base64.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`Uint8Array`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### hexBase64()
+
+> `static` **hexBase64**(`optionName`, `optionValue`, `allowEnvVar`): `Uint8Array`
+
+Check the option to see if it exists and is hex or base64.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`Uint8Array`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
+### bech32()
+
+> `static` **bech32**(`optionName`, `optionValue`, `allowEnvVar`): `string`
+
+Check the option to see if it exists and is bech32.
+
+#### Parameters
+
+• **optionName**: `string`
+
+The name of the option.
+
+• **optionValue**: `undefined` \| `string`
+
+The option value.
+
+• **allowEnvVar**: `boolean`= `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`string`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.