|
| 1 | +#CodeRoad Buidler - CLI |
| 2 | + |
| 3 | +Command line interface for[CodeRoad](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad). |
| 4 | + |
| 5 | +##Pre-Requisites |
| 6 | + |
| 7 | +-[NodeJS](https://nodejs.org/) |
| 8 | +-[Git](https://git-scm.com/downloads) |
| 9 | + |
| 10 | +##Install |
| 11 | + |
| 12 | +Use CodeRoad CLI to setup and build a tutorial configuration file. |
| 13 | + |
| 14 | +```shell |
| 15 | +npm install -g coderoad-cli |
| 16 | +``` |
| 17 | + |
| 18 | +##Craete |
| 19 | + |
| 20 | +```shell |
| 21 | +$ coderoad create |
| 22 | +``` |
| 23 | + |
| 24 | +Create templates files in the current folder for the content and setup files. |
| 25 | + |
| 26 | + |
| 27 | +##Build |
| 28 | + |
| 29 | +``` |
| 30 | +$ coderoad build [options] |
| 31 | +
|
| 32 | +options: |
| 33 | +
|
| 34 | + -g, --git Tutorial's remote git address. Either --git ot --dir should be provided. |
| 35 | + -d, --dir Tutorial's local directory. Either --git ot --dir should be provided. |
| 36 | + -c, --code Branch that contains the code. |
| 37 | + -s, --setup Branch that contains the TUTORIAL.md and coderoad.yaml files. |
| 38 | + -o, --output (Optional) Save the configuration in the output file. |
| 39 | + Log into the console if not set |
| 40 | + -h, --help (Optional) Show the help message |
| 41 | +``` |
| 42 | + |
| 43 | +Build the configuration file to be used by the extension to run the tutorial. The configuration file is created by matching the`level` and`step` ids between the`TUTORIAL.md` and`coderoad.yaml` files against git commit messages with the same ids. |