@acoustic-content-sdk/cli 中文文档教程

Question

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< /a> > @acoustic-content-sdk/cli

cli package

声学内容 SDK 的命令行实用程序。 这些命令可以直接从命令行使用，也可以通过基于 commander 的 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

主页 > @acoustic-content-sdk/cli > generateDataOverlayCommand

generateDataOverlayCommand() function

生成由节点模块及其所有依赖项引用的 wchtools 文件夹的数据覆盖。 然后可以将生成的文件夹与 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

首页 > @acoustic-content-sdk/cli > generateKeysCommand

generateKeysCommand() function

Signature:

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

Parameters

Parameter	Type	Description
program	Command

Returns:

Command

主页 > @acoustic-content-sdk/cli > generateLayoutCommand

generateLayoutCommand() function

Signature:

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

Parameters

Parameter	Type	Description
program	Command

Returns:

Command

主页 > @acoustic-content-sdk/cli > generateLayoutsCommand

generateLayoutsCommand() function

Signature:

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

Parameters

Parameter	Type	Description
program	Command

Returns:

Command

主页 > @acoustic-content-sdk/cli > 运行程序

runProgram() function

签名：

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

Parameters

Parameter	Type	Description
aArgs	string[]

返回：

import("commander").Command

@acoustic-content-sdk/cli > versionCommand

versionCommand() function

Signature:

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

Parameters

Parameter	Type	Description
program	Command

Returns:

Command

主页 > @acoustic-content-sdk/cli > VERSION

VERSION variable

软件包的版本和构建号

签名

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