@hashgraph/hedera-local/src/types/CLIOptions.ts

Developer tooling for running Local Hedera Network (Consensus + Mirror Nodes).

// SPDX-License-Identifier: Apache-2.0

/**
 * Represents the options that can be passed to the CLI.
 * 
 * @interface
 * @public
 * @property {number} accounts - The number of accounts to be created.
 * @property {boolean} async - Whether to run commands asynchronously.
 * @property {number} balance - The balance for the accounts.
 * @property {string} host - The host address.
 * @property {boolean} limits - Whether to impose limits.
 * @property {boolean} devMode - Whether to run in development mode.
 * @property {boolean} fullMode - Whether to run in full mode.
 * @property {boolean} blockNode - Whether to enable block-node.
 * @property {boolean} multiNode - Whether to run in multi-node mode.
 * @property {boolean} userCompose - Whether to use user compose.
 * @property {string} userComposeDir - The directory of the user compose file.
 * @property {boolean} blocklisting - Whether to enable blocklisting.
 * @property {boolean} startup - Whether to start up.
 * @property {number} verbose - The level of verbosity.
 * @property {string} networkTag - The tag for the network.
 * @property {string} mirrorTag - The tag for the mirror.
 * @property {string} relayTag - The tag for the relay.
 * @property {string} blockNodeTag - The tag for the block node.
 * @property {string} workDir - The working directory.
 * @property {boolean} createInitialResources - Whether to create initial resources.
 * @property {boolean} persistTransactionBytes - Whether to persist transaction bytes.
 */
export interface CLIOptions {
    accounts: number,
    async: boolean,
    balance: number,
    host: string,
    limits: boolean,
    devMode: boolean,
    fullMode: boolean,
    blockNode: boolean,
    multiNode: boolean,
    userCompose: boolean,
    userComposeDir: string,
    blocklisting: boolean,
    startup: boolean,
    verbose: number,
    networkTag: string,
    mirrorTag: string,
    relayTag: string,
    blockNodeTag: string,
    workDir: string,
    createInitialResources: boolean,
    persistTransactionBytes: boolean,
}