Command line utility for the Acoustic Content SDK.

Help

Show the available commands:

acoustic-content-sdk-cli --help

Show the options for each command:

acoustic-content-sdk-cli <command> --help

Documentation

API Documentation

Home > @acoustic-content-sdk/cli

cli package

Command line utility for the Acoustic Content SDK. The commands can be used directly from the command line or can be invoked via a commander based API.

Functions

| Function | Description | | --- | --- | | canonicalizeAssetsCommand(program) | | | generateDataOverlayCommand(program) | Generates a data overlay of the wchtools folders referenced by a node module and all of its dependencies. The resulting folder can then be used with wchtools. | | generateKeysCommand(program) | | | generateLayoutCommand(program) | | | generateLayoutsCommand(program) | | | runProgram(aArgs) | | | versionCommand(program) | |

Variables

| Variable | Description | | --- | --- | | VERSION | Version and build number of the package |

Home > @acoustic-content-sdk/cli > canonicalizeAssetsCommand

canonicalizeAssetsCommand() function

Signature:

export declare function canonicalizeAssetsCommand(program: Command): Command;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | program | Command | |

Returns:

Command

Home > @acoustic-content-sdk/cli > generateDataOverlayCommand

generateDataOverlayCommand() function

Generates a data overlay of the wchtools folders referenced by a node module and all of its dependencies. The resulting folder can then be used with wchtools.

Signature:

export declare function generateDataOverlayCommand(program: Command): Command;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | program | Command | the commander instance to attach the command to |

Returns:

Command

the commander instance

Home > @acoustic-content-sdk/cli > generateKeysCommand

generateKeysCommand() function

Signature:

export declare function generateKeysCommand(program: Command): Command;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | program | Command | |

Returns:

Command

Home > @acoustic-content-sdk/cli > generateLayoutCommand

generateLayoutCommand() function

Signature:

export declare function generateLayoutCommand(program: Command): Command;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | program | Command | |

Returns:

Command

Home > @acoustic-content-sdk/cli > generateLayoutsCommand

generateLayoutsCommand() function

Signature:

export declare function generateLayoutsCommand(program: Command): Command;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | program | Command | |

Returns:

Command

Home > @acoustic-content-sdk/cli > runProgram

runProgram() function

Signature:

export declare function runProgram(aArgs?: string[]): import("commander").Command;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aArgs | string[] | |

Returns:

import("commander").Command

Home > @acoustic-content-sdk/cli > versionCommand

versionCommand() function

Signature:

export declare function versionCommand(program: Command): Command;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | program | Command | |

Returns:

Command

Home > @acoustic-content-sdk/cli > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}