| 1 | <p align="center">
|
| 2 | <img src="https://kenticoprod.azureedge.net/kenticoblob/crestron/media/crestron/generalsiteimages/crestron-logo.png">
|
| 3 | </p>
|
| 4 |
|
| 5 | # CH5 Utilities CLI - Getting Started
|
| 6 |
|
| 7 | > Archiving and distribution utilities from the ch5-utilities library wrapped as CLI commands.
|
| 8 |
|
| 9 | ## Table of Contents
|
| 10 |
|
| 11 | - [Background](#background)
|
| 12 | - [Usage](#usage)
|
| 13 | - [License](#license)
|
| 14 |
|
| 15 | ## Background
|
| 16 |
|
| 17 | The purpose of the library is to expose the [ch5-utilities](https://www.npmjs.com/package/@crestron/ch5-utilities) archive and distribute functionality as two commands: `archive` and `deploy`.
|
| 18 |
|
| 19 |
|
| 20 | ## Usage
|
| 21 |
|
| 22 | The cli contains two commands: archive and deploy. After following the steps from above, just write `ch5-cli` in the terminal, and hit enter - it will display the default message for options and commands.
|
| 23 | For details about how to use the commands, you can write `ch5-cli archive --help` or `ch5-cli deploy --help` - this will display the options and what they mean.
|
| 24 |
|
| 25 |
|
| 26 | First you would need to run the archive command to generate the ch5z file, then you need to run the deploy command giving the archive path ( relative or absolute ).
|
| 27 |
|
| 28 | #### Examples
|
| 29 |
|
| 30 | ```
|
| 31 | > ch5-cli archive -p ch5-template-sample -d dist/NgCh5DemoHorizontal -o dist
|
| 32 | > ch5-cli deploy -H tshostname -t touchscreen dist/ch5-template-sample.ch5z
|
| 33 | ```
|
| 34 |
|
| 35 | ## License
|
| 36 |
|
| 37 | Copyright (C) 2018 to the present, Crestron Electronics, Inc.
|
| 38 | All rights reserved.
|
| 39 | No part of this software may be reproduced in any form, machine
|
| 40 | or natural, without the express written consent of Crestron Electronics.
|
| 41 | Use of this source code is subject to the terms of the Crestron Software
|
| 42 | Development Tools License Agreement under which you licensed this source code.
|
| 43 |
|
| 44 | If you did not accept the terms of the license agreement,
|
| 45 | you are not authorized to use this software. For the terms of the license,
|
| 46 | please see the license agreement between you and Crestron at http://www.crestron.com/sla.
|