@twin.org/cli-core 0.0.1-next.6 → 0.0.1-next.62

package/docs/reference/classes/CLIOptions.md

@@ -4,13 +4,13 @@ Utilities for getting standard options.
 
 ## Constructors
 
-### new CLIOptions()
+### Constructor
 
-> **new CLIOptions**(): [`CLIOptions`](CLIOptions.md)
+> **new CLIOptions**(): `CLIOptions`
 
 #### Returns
 
-[`CLIOptions`](CLIOptions.md)
+`CLIOptions`
 
 ## Methods
 
@@ -22,31 +22,43 @@ Get the options for output.
 
 #### Parameters
 
-• **command**: `Command`
+##### command
+
+`Command`
 
 The command to add the options to.
 
-• **opts**
+##### opts
 
 The options of what to include.
 
-• **opts.noConsole**: `boolean`
+###### noConsole
+
+`boolean`
 
 Do not output to the console.
 
-• **opts.json**: `boolean`
+###### json
+
+`boolean`
 
 Output to a JSON file.
 
-• **opts.env**: `boolean`
+###### env
+
+`boolean`
 
 Output to an environment file.
 
-• **opts.mergeJson**: `boolean`
+###### mergeJson
+
+`boolean`
 
 Merge existing JSON file.
 
-• **opts.mergeEnv**: `boolean`
+###### mergeEnv
+
+`boolean`
 
 Merge existing environment file.
 

package/docs/reference/classes/CLIParam.md

@@ -4,13 +4,13 @@ Parameter utilities for the CLI.
 
 ## Constructors
 
-### new CLIParam()
+### Constructor
 
-> **new CLIParam**(): [`CLIParam`](CLIParam.md)
+> **new CLIParam**(): `CLIParam`
 
 #### Returns
 
-[`CLIParam`](CLIParam.md)
+`CLIParam`
 
 ## Methods
 
@@ -22,15 +22,21 @@ Check the option to see if it exists.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean`
 
 Allow the option to be read from an env var.
 
@@ -50,19 +56,25 @@ An error if the option is invalid.
 
 > `static` **stringValue**(`optionName`, `optionValue`, `allowEnvVar`): `string`
 
-Check the option to see if it exists.
+Check the option to see if the String exists.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -82,19 +94,25 @@ An error if the option is invalid.
 
 > `static` **url**(`optionName`, `optionValue`, `allowEnvVar`): `string`
 
-Check the option to see if it a url.
+Check the option to see if it is a url.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -112,29 +130,39 @@ An error if the option is invalid.
 
 ### number()
 
-> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `number`
+> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
 
 Check the option to see if it exists and is a number.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
-• **minValue**: `number` = `0`
+##### minValue
+
+`number` = `0`
 
 The minimum value.
 
-• **maxValue?**: `number`
+##### maxValue?
+
+`number`
 
 The maximum value.
 
@@ -152,29 +180,39 @@ An error if the option is invalid.
 
 ### integer()
 
-> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `number`
+> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
 
 Check the option to see if it exists and is an integer.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
-• **minValue**: `number` = `0`
+##### minValue
+
+`number` = `0`
 
 The minimum value.
 
-• **maxValue?**: `number`
+##### maxValue?
+
+`number`
 
 The maximum value.
 
@@ -192,29 +230,39 @@ An error if the option is invalid.
 
 ### bigint()
 
-> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `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`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
-• **minValue**: `bigint` = `...`
+##### minValue
+
+`bigint` = `0n`
 
 The minimum value.
 
-• **maxValue?**: `bigint`
+##### maxValue?
+
+`bigint`
 
 The maximum value.
 
@@ -238,15 +286,21 @@ Check the option to see if it exists and is a boolean.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -270,15 +324,21 @@ Check the option to see if it exists and is hex.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -302,15 +362,21 @@ Check the option to see if it exists and is base64.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -334,15 +400,21 @@ Check the option to see if it exists and is hex or base64.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -366,15 +438,21 @@ Check the option to see if it exists and is bech32.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 

package/docs/reference/classes/CLIUtils.md

@@ -4,13 +4,13 @@ Utilities function for helping in the CLI.
 
 ## Constructors
 
-### new CLIUtils()
+### Constructor
 
-> **new CLIUtils**(): [`CLIUtils`](CLIUtils.md)
+> **new CLIUtils**(): `CLIUtils`
 
 #### Returns
 
-[`CLIUtils`](CLIUtils.md)
+`CLIUtils`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Does the specified file exist.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to check for existence.
 
@@ -42,7 +44,9 @@ Does the specified file exist, synchronously.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to check for existence.
 
@@ -62,7 +66,9 @@ Check if the dir exists.
 
 #### Parameters
 
-• **dir**: `string`
+##### dir
+
+`string`
 
 The directory to check.
 
@@ -82,7 +88,9 @@ Check if the dir exists, synchronously.
 
 #### Parameters
 
-• **dir**: `string`
+##### dir
+
+`string`
 
 The directory to check.
 
@@ -102,11 +110,15 @@ Read a JSON file and parse it.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -126,11 +138,15 @@ Read a JSON file and parse it, synchronously.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -150,7 +166,9 @@ Read a file as lines.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -170,7 +188,9 @@ Read a file as lines, synchronously.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -190,7 +210,9 @@ Find the NPM root based on a package.json path.
 
 #### Parameters
 
-• **rootFolder**: `string`
+##### rootFolder
+
+`string`
 
 The path to the package.json.
 
@@ -204,21 +226,61 @@ The root path.
 
 ### runShellCmd()
 
-> `static` **runShellCmd**(`app`, `args`, `cwd`): `Promise`\<`void`\>
+> `static` **runShellCmd**(`command`, `args`, `cwd`): `Promise`\<`void`\>
+
+Run a shell command.
+
+#### Parameters
+
+##### command
+
+`string`
+
+The app to run in the shell.
+
+##### args
+
+`string`[]
+
+The args for the app.
+
+##### cwd
+
+`string`
+
+The working directory to execute the command in.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise to wait for command execution to complete.
+
+***
+
+### runShellApp()
+
+> `static` **runShellApp**(`app`, `args`, `cwd`): `Promise`\<`void`\>
 
 Run a shell app.
 
 #### Parameters
 
-• **app**: `string`
+##### app
+
+`string`
 
 The app to run in the shell.
 
-• **args**: `string`[]
+##### args
+
+`string`[]
 
 The args for the app.
 
-• **cwd**: `string`
+##### cwd
+
+`string`
 
 The working directory to execute the command in.
 
@@ -238,19 +300,27 @@ Write a JSON file.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **jsonFilename**: `undefined` \| `string`
+##### jsonFilename
 
 The filename to write.
 
-• **data**: `T`
+`undefined` | `string`
+
+##### data
+
+`T`
 
 The data to write.
 
-• **append**: `boolean`
+##### append
+
+`boolean`
 
 Append to the file.
 
@@ -268,15 +338,21 @@ Write an env file.
 
 #### Parameters
 
-• **envFilename**: `undefined` \| `string`
+##### envFilename
 
 The filename to write.
 
-• **data**: `string`[]
+`undefined` | `string`
+
+##### data
+
+`string`[]
 
 The data to write.
 
-• **append**: `boolean`
+##### append
+
+`boolean`
 
 Append to the file.
 

package/docs/reference/functions/addGlobalOptions.md

@@ -6,15 +6,21 @@ Add the global options.
 
 ## Parameters
 
-• **program**: `Command`
+### program
+
+`Command`
 
 The program to add the options to.
 
-• **supportsLang**: `boolean`
+### supportsLang
+
+`boolean`
 
 Whether the CLI supports different languages.
 
-• **supportsEnvFiles**: `boolean`
+### supportsEnvFiles
+
+`boolean`
 
 Whether the CLI supports loading env files
 

package/docs/reference/functions/initGlobalOptions.md

@@ -6,7 +6,9 @@ Initialize the global options.
 
 ## Parameters
 
-• **localesDirectory**: `string`
+### localesDirectory
+
+`string`
 
 The path to load the locales from.