@twin.org/node-core 0.0.3-next.66 → 0.0.3-next.67

package/dist/types/models/ICliCommandDefinition.d.ts

@@ -1,7 +1,7 @@
 import type { IEngineCore } from "@twin.org/engine-models";
 import type { CliCommandParamType } from "./cliCommandParamType.js";
 import type { ICliCommandDefinitionParam } from "./ICliCommandDefinitionParam.js";
-import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
+import type { IEnvironmentVariables } from "./IEnvironmentVariables.js";
 /**
  * Static definition of a CLI command including its name, parameters, and execution action.
  */
@@ -25,7 +25,7 @@ export interface ICliCommandDefinition {
     /**
      * The method to execute for the command.
      */
-    action: (engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    action: (engineCore: IEngineCore, envVars: IEnvironmentVariables, params: {
         [id: string]: CliCommandParamType;
     }) => Promise<unknown>;
     /**

package/dist/types/models/IEngineEnvironmentVariables.d.ts

@@ -10,6 +10,22 @@ export interface IEngineEnvironmentVariables {
      * Start the engine in silent mode.
      */
     silent?: string;
+    /**
+     * Controls how unrecognised TWIN_* environment variables are handled at startup.
+     * "error" (default): throws a startup error, allowing CI and production deployments
+     * to hard-fail on misconfigured or misspelled variable names.
+     * "warn": logs a warning and continues.
+     * "ignore": skips validation entirely.
+     * Any other value is rejected at startup.
+     * @default "error"
+     */
+    strictEnv?: string;
+    /**
+     * Comma-separated list of raw environment variable names to exempt from the unknown-key check.
+     * Use this to allowlist variables introduced by custom extensions that are not part of the
+     * core interface, e.g. TWIN_MY_EXTENSION_SECRET.
+     */
+    envAllowList?: string;
     /**
      * The root directory for storing items like state file.
      */
@@ -56,9 +72,9 @@ export interface IEngineEnvironmentVariables {
      */
     awsDynamodbSecretAccessKey?: string;
     /**
-     * AWS Dynamo DB connection timeout.
+     * AWS Dynamo DB connection timeout in milliseconds.
      */
-    awsDynamodbConnectionTimeoutMs?: string;
+    awsDynamodbConnectionTimeout?: string;
     /**
      * Azure Cosmos DB key.
      */
@@ -283,7 +299,7 @@ export interface IEngineEnvironmentVariables {
     /**
      * The batch flush interval in seconds for the logging task, how often to flush the logs when using batching, defaults to 5 seconds.
      */
-    loggingBatchFlushIntervalSeconds?: string;
+    loggingBatchFlushInterval?: string;
     /**
      * A list of components to exclude from logging, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
      */
@@ -359,7 +375,7 @@ export interface IEngineEnvironmentVariables {
     /**
      * Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
      */
-    telemetryMetricsCollectorIntervalSeconds?: string;
+    telemetryMetricsCollectorInterval?: string;
     /**
      * The type of telemetry metrics producers, can be a comma separated list: system, process.
      */
@@ -506,10 +522,10 @@ export interface IEngineEnvironmentVariables {
      */
     trustVerificationMethodId?: string;
     /**
-     * The trust time to live for generating JWTs.
+     * The trust time to live for generating JWTs in seconds.
      * Defaults to undefined for never expiring.
      */
-    trustJwtTtlSeconds?: string;
+    trustJwtTtl?: string;
     /**
      * The allow lists for the trust identity verifier, comma separated list of identities.
      */
@@ -562,13 +578,13 @@ export interface IEngineEnvironmentVariables {
      */
     dataspaceEnabled?: string;
     /**
-     * The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
-     * @default 10
+     * The length of time to retain the activity logs for in seconds, set to -1 to keep forever.
+     * @default 600
      */
     dataspaceRetainActivityLogsFor?: string;
     /**
-     * The interval in minutes for cleaning up the activity logs.
-     * @default 60
+     * The interval in seconds for cleaning up the activity logs.
+     * @default 3600
      */
     dataspaceActivityLogsCleanupInterval?: string;
     /**
@@ -585,12 +601,12 @@ export interface IEngineEnvironmentVariables {
      */
     dataspaceAutoStartTransfers?: string;
     /**
-     * How long in minutes a negotiation may sit without progress before it is treated as timed out.
+     * How long in seconds a negotiation may sit without progress before it is treated as timed out.
      * @default 30
      */
     dataspaceStalledNegotiationTimeout?: string;
     /**
-     * How long in minutes a consumer-initiated transfer may sit in REQUESTED without the provider
+     * How long in seconds a consumer-initiated transfer may sit in REQUESTED without the provider
      * progressing it before it is treated as timed out.
      * @default 30
      */
@@ -599,6 +615,7 @@ export interface IEngineEnvironmentVariables {
      * Path under which the dataspace control plane is mounted (path only, not full URL).
      * This must match the control-plane REST mount, as it is combined with the public
      * origin to build the consumer's advertised callback address.
+     * @default "dataspace-control-plane"
      */
     dataspaceCallbackPath?: string;
     /**
@@ -608,12 +625,12 @@ export interface IEngineEnvironmentVariables {
     /**
      * The interval in seconds for performing health checks, defaults to 60.
      */
-    healthIntervalSeconds?: string;
+    healthInterval?: string;
     /**
      * The interval in seconds for performing health checks at startup, defaults to 2.
      * This allows components that take a long time to initialize to be healthy before the first health check is performed.
      */
-    healthStartupIntervalSeconds?: string;
+    healthStartupInterval?: string;
     /**
      * The type of the automation action to create, comma separate for more than one connector.
      * values: fetch
@@ -626,35 +643,35 @@ export interface IEngineEnvironmentVariables {
     /**
      * The mutex timeout in milliseconds for the auditable item graph component.
      */
-    auditableItemGraphMutexTimeoutMs?: string;
+    auditableItemGraphMutexTimeout?: string;
     /**
      * The mutex timeout in milliseconds for the auditable item stream component.
      */
-    auditableItemStreamMutexTimeoutMs?: string;
+    auditableItemStreamMutexTimeout?: string;
     /**
      * The mutex timeout in milliseconds for the federated catalogue component.
      */
-    federatedCatalogueMutexTimeoutMs?: string;
+    federatedCatalogueMutexTimeout?: string;
     /**
      * The mutex timeout in milliseconds for the document management component.
      */
-    documentManagementMutexTimeoutMs?: string;
+    documentManagementMutexTimeout?: string;
     /**
      * The mutex timeout in milliseconds for the logging component.
      */
-    loggingMutexTimeoutMs?: string;
+    loggingMutexTimeout?: string;
     /**
      * The mutex timeout in milliseconds for the memory entity storage connector.
      */
-    entityStorageMemoryMutexTimeoutMs?: string;
+    entityStorageMemoryMutexTimeout?: string;
     /**
      * The mutex timeout in milliseconds for the file entity storage connector.
      */
-    entityStorageFileMutexTimeoutMs?: string;
+    entityStorageFileMutexTimeout?: string;
     /**
      * The mutex timeout in milliseconds for the rights management component.
      */
-    rightsManagementMutexTimeoutMs?: string;
+    rightsManagementMutexTimeout?: string;
     /**
      * A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
      */

package/dist/types/models/IEngineServerEnvironmentVariables.d.ts

@@ -1,8 +1,7 @@
-import type { IEngineEnvironmentVariables } from "./IEngineEnvironmentVariables.js";
 /**
  * The engine server environment variables.
  */
-export interface IEngineServerEnvironmentVariables extends IEngineEnvironmentVariables {
+export interface IEngineServerEnvironmentVariables {
     /**
      * The port to serve the API from.
      */

package/dist/types/models/IEnvironmentVariables.d.ts

@@ -0,0 +1,8 @@
+import type { IBootstrapLegacyEnvironmentVariables } from "./IBootstrapLegacyEnvironmentVariables.js";
+import type { IEngineEnvironmentVariables } from "./IEngineEnvironmentVariables.js";
+import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironmentVariables.js";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
+/**
+ * The environment variables.
+ */
+export type IEnvironmentVariables = IBootstrapLegacyEnvironmentVariables & INodeEnvironmentVariables & IEngineEnvironmentVariables & IEngineServerEnvironmentVariables;

package/dist/types/models/INodeEnvironmentVariables.d.ts

@@ -1,8 +1,7 @@
-import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironmentVariables.js";
 /**
  * The environment variables for the node.
  */
-export interface INodeEnvironmentVariables extends IEngineServerEnvironmentVariables {
+export interface INodeEnvironmentVariables {
     /**
      * Maximum size in MB for HTTPS extensions downloads.
      * @default 10

package/dist/types/models/INodeOptions.d.ts

@@ -1,7 +1,7 @@
 import type { IEngineCore, IEngineServer, IEngineStateStorage } from "@twin.org/engine-models";
 import type { IEngineConfig } from "@twin.org/engine-types";
+import type { IEnvironmentVariables } from "./IEnvironmentVariables.js";
 import type { INodeEngineConfig } from "./INodeEngineConfig.js";
-import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
 /**
  * The options when running the node.
  */
@@ -63,11 +63,11 @@ export interface INodeOptions {
     /**
      * Method to extend the engine environment variables with any additional custom configuration.
      */
-    extendEnvVars?: (envVars: INodeEnvironmentVariables) => Promise<void>;
+    extendEnvVars?: (envVars: IEnvironmentVariables) => Promise<void>;
     /**
      * Method to extend the engine configuration with any additional custom configuration.
      */
-    extendConfig?: (envVars: INodeEnvironmentVariables, config: INodeEngineConfig) => Promise<void>;
+    extendConfig?: (envVars: IEnvironmentVariables, config: INodeEngineConfig) => Promise<void>;
     /**
      * Method to extend the engine with any additional options.
      */

package/dist/types/models/bootstrapLegacyEnvironmentVariableKeys.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The set of camelCase property names that are valid IBootstrapLegacyEnvironmentVariables keys.
+ */
+export declare const BOOTSTRAP_LEGACY_ENVIRONMENT_VARIABLE_KEYS: ReadonlySet<string>;

package/dist/types/models/engineEnvironmentVariableKeys.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The set of camelCase property names that are valid IEngineEnvironmentVariables keys.
+ */
+export declare const ENGINE_ENVIRONMENT_VARIABLE_KEYS: ReadonlySet<string>;

package/dist/types/models/engineServerEnvironmentVariableKeys.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The set of camelCase property names (and wildcard patterns ending with *) that are valid
+ * IEngineServerEnvironmentVariables keys.
+ * Used at startup to detect unrecognised TWIN_* environment variables (typos, stale names).
+ * The "restPath*" entry covers dynamic TWIN_REST_PATH_<COMPONENT_TYPE> variables.
+ */
+export declare const ENGINE_SERVER_ENVIRONMENT_VARIABLE_KEYS: ReadonlySet<string>;

package/dist/types/models/nodeEnvironmentVariableKeys.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The set of camelCase property names that are valid INodeEnvironmentVariables keys.
+ * Used at startup to detect unrecognised TWIN_* environment variables (typos, stale names).
+ */
+export declare const NODE_ENVIRONMENT_VARIABLE_KEYS: ReadonlySet<string>;

package/dist/types/models/nodeExtensionInitialiseMethod.d.ts

@@ -1,9 +1,9 @@
+import type { IEnvironmentVariables } from "./IEnvironmentVariables.js";
 import type { INodeEngineConfig } from "./INodeEngineConfig.js";
-import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
 /**
  * The type for the initialise method of an extension module.
  * @param envVars The environment variables for the node.
  * @param nodeEngineConfig The node engine config.
  * @returns A promise that resolves when the extension configuration initialisation is complete.
  */
-export type NodeExtensionInitialiseMethod = (envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;
+export type NodeExtensionInitialiseMethod = (envVars: IEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;

package/dist/types/node.d.ts

@@ -2,9 +2,9 @@ import type { IServerInfo } from "@twin.org/api-models";
 import type { Engine } from "@twin.org/engine";
 import type { EngineServer } from "@twin.org/engine-server";
 import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import type { IEnvironmentVariables } from "./models/IEnvironmentVariables.js";
 import type { INodeEngineConfig } from "./models/INodeEngineConfig.js";
 import type { INodeEngineState } from "./models/INodeEngineState.js";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
 import type { INodeOptions } from "./models/INodeOptions.js";
 /**
  * Run the TWIN Node.
@@ -28,7 +28,7 @@ export declare function run(nodeOptions?: INodeOptions, args?: string[]): Promis
 export declare function buildConfiguration(processEnv: {
     [id: string]: string;
 }, options: INodeOptions, serverInfo: IServerInfo): Promise<{
-    nodeEnvVars: INodeEnvironmentVariables & {
+    nodeEnvVars: IEnvironmentVariables & {
         [id: string]: string | unknown;
     };
     nodeEngineConfig: INodeEngineConfig;
@@ -42,4 +42,4 @@ export declare function buildConfiguration(processEnv: {
  * @param executionDirectory The execution directory for resolving local module paths.
  * @param envVars The environment variables containing extension configuration (optional, uses defaults if not provided).
  */
-export declare function overrideModuleImport(executionDirectory: string, envVars?: INodeEnvironmentVariables): void;
+export declare function overrideModuleImport(executionDirectory: string, envVars?: IEnvironmentVariables): void;

package/dist/types/start.d.ts

@@ -2,9 +2,10 @@ import { Engine } from "@twin.org/engine";
 import { EngineServer } from "@twin.org/engine-server";
 import type { IEngineServerConfig } from "@twin.org/engine-server-types";
 import type { ICliCommand } from "./models/ICliCommand.js";
+import type { IEngineEnvironmentVariables } from "./models/IEngineEnvironmentVariables.js";
+import type { IEnvironmentVariables } from "./models/IEnvironmentVariables.js";
 import type { INodeEngineConfig } from "./models/INodeEngineConfig.js";
 import type { INodeEngineState } from "./models/INodeEngineState.js";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
 import type { INodeOptions } from "./models/INodeOptions.js";
 /**
  * Start the engine server.
@@ -15,7 +16,7 @@ import type { INodeOptions } from "./models/INodeOptions.js";
  * @param availableContextIdKeys The context ID keys available for operation.
  * @returns The engine server.
  */
-export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables, cliCommand?: ICliCommand, availableContextIdKeys?: {
+export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: IEnvironmentVariables & IEngineEnvironmentVariables, cliCommand?: ICliCommand, availableContextIdKeys?: {
     key: string;
     requiredHandlerFeatures: string[];
 }[]): Promise<{

package/docs/changelog.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.0.3-next.67](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.66...node-core-v0.0.3-next.67) (2026-06-24)
+
+
+### Features
+
+* env var validation ([#243](https://github.com/iotaledger/twin-node/issues/243)) ([569945a](https://github.com/iotaledger/twin-node/commit/569945a751eb52d008a681777a3cba881af1b9a4))
+
+
+### Bug Fixes
+
+* stalled timeout now is provided in seconds ([#241](https://github.com/iotaledger/twin-node/issues/241)) ([ebd827d](https://github.com/iotaledger/twin-node/commit/ebd827d02a9a4f8ad4f4c84d064d02831ef015cb))
+
 ## [0.0.3-next.66](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.65...node-core-v0.0.3-next.66) (2026-06-23)
 
 

package/docs/reference/functions/buildConfiguration.md

@@ -1,6 +1,6 @@
 # Function: buildConfiguration()
 
-> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
+> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`IBootstrapLegacyEnvironmentVariables`](../interfaces/IBootstrapLegacyEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
 
 Build the configuration for the TWIN Node.
 
@@ -24,7 +24,7 @@ The server information.
 
 ## Returns
 
-`Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
+`Promise`\<\{ `nodeEnvVars`: [`IBootstrapLegacyEnvironmentVariables`](../interfaces/IBootstrapLegacyEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
 
 A promise that resolves to the engine server configuration, environment prefix, environment variables,
 and options.

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -8,7 +8,7 @@ Handles the configuration of the server.
 
 ### envVars
 
-[`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md) & `object`
+[`IBootstrapLegacyEnvironmentVariables`](../interfaces/IBootstrapLegacyEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md) & `object`
 
 The environment variables for the engine server.
 

package/docs/reference/functions/executeCommand.md

@@ -14,7 +14,7 @@ The engine core.
 
 ### envVars
 
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/extensionsConfiguration.md

@@ -8,7 +8,7 @@ Handles the configuration of the extensions.
 
 ### envVars
 
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/extensionsInitialiseEngine.md

@@ -8,7 +8,7 @@ Handles the initialisation of the extensions when the engine has been constructe
 
 ### envVars
 
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/extensionsInitialiseEngineServer.md

@@ -8,7 +8,7 @@ Handles the initialisation of the extensions when the engine server has been con
 
 ### envVars
 
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/isAuthEntityStorageRequired.md

@@ -9,7 +9,7 @@ Returns true when any component that depends on the authentication entity storag
 
 ### envVars
 
-[`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 The environment variables.
 

package/docs/reference/functions/overrideModuleImport.md

@@ -14,7 +14,7 @@ The execution directory for resolving local module paths.
 
 ### envVars?
 
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 The environment variables containing extension configuration (optional, uses defaults if not provided).
 

package/docs/reference/functions/shutdownExtensions.md

@@ -8,7 +8,7 @@ Handles the shutdown of the extensions.
 
 ### envVars
 
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/start.md

@@ -20,7 +20,7 @@ The configuration for the engine server.
 
 ### envVars
 
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+[`IBootstrapLegacyEnvironmentVariables`](../interfaces/IBootstrapLegacyEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
 
 The environment variables.
 

package/docs/reference/index.md

@@ -2,6 +2,7 @@
 
 ## Interfaces
 
+- [IBootstrapLegacyEnvironmentVariables](interfaces/IBootstrapLegacyEnvironmentVariables.md)
 - [ICacheMetadata](interfaces/ICacheMetadata.md)
 - [ICliArgs](interfaces/ICliArgs.md)
 - [ICliCommand](interfaces/ICliCommand.md)
@@ -18,6 +19,7 @@
 
 ## Type Aliases
 
+- [IEnvironmentVariables](type-aliases/IEnvironmentVariables.md)
 - [CliCommandParamType](type-aliases/CliCommandParamType.md)
 - [ModuleProtocol](type-aliases/ModuleProtocol.md)
 - [NodeExtensionInitialiseEngineMethod](type-aliases/NodeExtensionInitialiseEngineMethod.md)

package/docs/reference/interfaces/IBootstrapLegacyEnvironmentVariables.md

@@ -0,0 +1,117 @@
+# Interface: IBootstrapLegacyEnvironmentVariables
+
+The environment variables for the bootstrap legacy.
+
+## Properties
+
+### features? {#features}
+
+> `optional` **features?**: `string`
+
+The features that are enabled on the node.
+
+#### Default
+
+```ts
+[]
+```
+
+***
+
+### nodeIdentity? {#nodeidentity}
+
+> `optional` **nodeIdentity?**: `string`
+
+The identity of the node which, if empty and node-identity feature is enabled it will be generated.
+
+***
+
+### nodeMnemonic? {#nodemnemonic}
+
+> `optional` **nodeMnemonic?**: `string`
+
+The mnemonic for the node identity, if empty it will be randomly generated.
+
+***
+
+### tenantId? {#tenantid}
+
+> `optional` **tenantId?**: `string`
+
+A tenant id to use as a default for the node.
+
+***
+
+### tenantApiKey? {#tenantapikey}
+
+> `optional` **tenantApiKey?**: `string`
+
+A tenant api key to use as a default for the node.
+
+***
+
+### organizationIdentity? {#organizationidentity}
+
+> `optional` **organizationIdentity?**: `string`
+
+The organisation identity. If not provided it will be generated.
+
+***
+
+### organizationMnemonic? {#organizationmnemonic}
+
+> `optional` **organizationMnemonic?**: `string`
+
+The mnemonic for the organisation identity, if empty it will be randomly generated.
+
+***
+
+### adminUserIdentity? {#adminuseridentity}
+
+> `optional` **adminUserIdentity?**: `string`
+
+If the admin-user feature is enabled, this will be the identity of the user. If not provided it will be generated.
+
+***
+
+### adminUserMnemonic? {#adminusermnemonic}
+
+> `optional` **adminUserMnemonic?**: `string`
+
+The mnemonic for the admin user, if empty it will be randomly generated.
+
+***
+
+### adminUserName? {#adminusername}
+
+> `optional` **adminUserName?**: `string`
+
+If the admin-user feature is enabled, this will be the name of the user.
+
+#### Default
+
+```ts
+admin@node
+```
+
+***
+
+### adminUserPassword? {#adminuserpassword}
+
+> `optional` **adminUserPassword?**: `string`
+
+If the admin-user feature is enabled, this will be the password of the user. If empty it will be randomly generated.
+
+***
+
+### adminUserScope? {#adminuserscope}
+
+> `optional` **adminUserScope?**: `string`
+
+If the admin-user feature is enabled, this is a comma-separated list of scopes for the user.
+
+#### Default
+
+```ts
+tenant-admin,user-admin (when tenant enabled) or user-admin (when tenant disabled)
+```

package/docs/reference/interfaces/ICliCommandDefinition.md

@@ -50,7 +50,7 @@ The method to execute for the command.
 
 ##### envVars
 
-[`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
 
 ##### params