@acoustic-content-sdk/cli
Version:
Command line utility for the Acoustic Content SDK.
248 lines (151 loc) • 8.65 kB
Markdown
<a name="_d71f02f6aa667200431a3174865f7fa3d8ae0b7a7207a21602090bdeebf72cfc"></a>
[](https://www.npmjs.com/package/@acoustic-content-sdk/cli)
Command line utility for the Acoustic Content SDK.
## Help
Show the available commands:
```bash
acoustic-content-sdk-cli --help
```
Show the options for each command:
```bash
acoustic-content-sdk-cli <command> --help
```
## Documentation
[API Documentation](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed)
<a name="_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed)
## 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](https://www.npmjs.com/package/commander) based API.
## Functions
| Function | Description |
| --- | --- |
| [canonicalizeAssetsCommand(program)](#_11fa30a4625cda301dbb8061c3b2b6fe246e3e6a61895a4d783536cf1f04cdbc) | |
| [generateDataOverlayCommand(program)](#_c6d2cfbcefbde0ee0ab1bebe0a29ca138166a804638f886c4bbd661b14239ee5) | 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](https://www.npmjs.com/package/wchtools-cli)<!-- -->. |
| [generateKeysCommand(program)](#_e8257aaa383bf386afd4d31f7c732e6b4ed5c99ec7b8a94d624701f091c2b44c) | |
| [generateLayoutCommand(program)](#_24f9698e3fa50a62f1aaee90d1bad889df1a22fc03f914d18b7e2a4cad0e0fd1) | |
| [generateLayoutsCommand(program)](#_5efad56ed022fd0dfeaacfd77568eecf1e858e200219f29967b9e4b84838ebbf) | |
| [runProgram(aArgs)](#_8db82a20b4d85e5abfcf64b38d79115d96caf4c06f4c8fd1ab6c1226837ce253) | |
| [versionCommand(program)](#_6b4f16a9e8b2e4cc0cac3ff448a808e5a4fd24f19427f0936f49a3b6b1cd73f5) | |
## Variables
| Variable | Description |
| --- | --- |
| [VERSION](#_1444b5ec219618df2f830fd801c576b481e4d806bb1389cd086548404ee29004) | Version and build number of the package |
<a name="_d71f02f6aa667200431a3174865f7fa3d8ae0b7a7207a21602090bdeebf72cfc"></a>
<a name="_11fa30a4625cda301dbb8061c3b2b6fe246e3e6a61895a4d783536cf1f04cdbc"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [canonicalizeAssetsCommand](#_11fa30a4625cda301dbb8061c3b2b6fe246e3e6a61895a4d783536cf1f04cdbc)
## canonicalizeAssetsCommand() function
<b>Signature:</b>
```typescript
export declare function canonicalizeAssetsCommand(program: Command): Command;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| program | <code>Command</code> | |
<b>Returns:</b>
`Command`
<a name="_c6d2cfbcefbde0ee0ab1bebe0a29ca138166a804638f886c4bbd661b14239ee5"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [generateDataOverlayCommand](#_c6d2cfbcefbde0ee0ab1bebe0a29ca138166a804638f886c4bbd661b14239ee5)
## 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](https://www.npmjs.com/package/wchtools-cli)<!-- -->.
<b>Signature:</b>
```typescript
export declare function generateDataOverlayCommand(program: Command): Command;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| program | <code>Command</code> | the commander instance to attach the command to |
<b>Returns:</b>
`Command`
the commander instance
<a name="_e8257aaa383bf386afd4d31f7c732e6b4ed5c99ec7b8a94d624701f091c2b44c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [generateKeysCommand](#_e8257aaa383bf386afd4d31f7c732e6b4ed5c99ec7b8a94d624701f091c2b44c)
## generateKeysCommand() function
<b>Signature:</b>
```typescript
export declare function generateKeysCommand(program: Command): Command;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| program | <code>Command</code> | |
<b>Returns:</b>
`Command`
<a name="_24f9698e3fa50a62f1aaee90d1bad889df1a22fc03f914d18b7e2a4cad0e0fd1"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [generateLayoutCommand](#_24f9698e3fa50a62f1aaee90d1bad889df1a22fc03f914d18b7e2a4cad0e0fd1)
## generateLayoutCommand() function
<b>Signature:</b>
```typescript
export declare function generateLayoutCommand(program: Command): Command;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| program | <code>Command</code> | |
<b>Returns:</b>
`Command`
<a name="_5efad56ed022fd0dfeaacfd77568eecf1e858e200219f29967b9e4b84838ebbf"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [generateLayoutsCommand](#_5efad56ed022fd0dfeaacfd77568eecf1e858e200219f29967b9e4b84838ebbf)
## generateLayoutsCommand() function
<b>Signature:</b>
```typescript
export declare function generateLayoutsCommand(program: Command): Command;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| program | <code>Command</code> | |
<b>Returns:</b>
`Command`
<a name="_8db82a20b4d85e5abfcf64b38d79115d96caf4c06f4c8fd1ab6c1226837ce253"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [runProgram](#_8db82a20b4d85e5abfcf64b38d79115d96caf4c06f4c8fd1ab6c1226837ce253)
## runProgram() function
<b>Signature:</b>
```typescript
export declare function runProgram(aArgs?: string[]): import("commander").Command;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| aArgs | <code>string[]</code> | |
<b>Returns:</b>
`import("commander").Command`
<a name="_6b4f16a9e8b2e4cc0cac3ff448a808e5a4fd24f19427f0936f49a3b6b1cd73f5"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [versionCommand](#_6b4f16a9e8b2e4cc0cac3ff448a808e5a4fd24f19427f0936f49a3b6b1cd73f5)
## versionCommand() function
<b>Signature:</b>
```typescript
export declare function versionCommand(program: Command): Command;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| program | <code>Command</code> | |
<b>Returns:</b>
`Command`
<a name="_1444b5ec219618df2f830fd801c576b481e4d806bb1389cd086548404ee29004"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](#_1590fd8a7d835538848f8526c4cbe8edd3bf527adebf26857c52e9a60a744e2e) > [@acoustic-content-sdk/cli](#_f628c997abd28b2745a49ff4a7870619a5119cedab4e55cf84b6cef0a8e0f8ed) > [VERSION](#_1444b5ec219618df2f830fd801c576b481e4d806bb1389cd086548404ee29004)
## VERSION variable
Version and build number of the package
<b>Signature:</b>
```typescript
VERSION: {
version: {
major: string;
minor: string;
patch: string;
branch: string;
};
build: Date;
}
```