Woodford CLI: Difference between revisions
No edit summary |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
You can control certain functions of [[Woodford]], such as publishing projects, from the command line. | You can control certain functions of [[Woodford]], such as publishing projects, from the command line. | ||
| Line 5: | Line 4: | ||
* Minimum version: [[Releases/Spring_2022|15.0]] | * Minimum version: [[Releases/Spring_2022|15.0]] | ||
* | * Supported backends: [[Resco Cloud]], [[Dynamics]] | ||
== Available functions == | == Available functions == | ||
| Line 17: | Line 16: | ||
To install CLI globally, run the following command: | To install CLI globally, run the following command: | ||
<code>npm install -g woodford-cli</code> | <code>npm install -g @resconet/woodford-cli</code> | ||
To uninstall CLI, run the following command. | To uninstall CLI, run the following command. | ||
<code>npm uninstall -g woodford-cli</code> | <code>npm uninstall -g @resconet/woodford-cli</code> | ||
== Usage == | == Usage == | ||
| Line 29: | Line 28: | ||
<code>wf-cli</code> | <code>wf-cli</code> | ||
The supported command-line parameters are described [https://www.npmjs.com/package/@resconet/woodford-cli | The supported command-line parameters are described [https://www.npmjs.com/package/@resconet/woodford-cli in the npmjs package readme document]. | ||
[[Category:Woodford]] | [[Category:Woodford]] | ||
Latest revision as of 13:42, 12 July 2022
You can control certain functions of Woodford, such as publishing projects, from the command line.
Prerequisites
- Minimum version: 15.0
- Supported backends: Resco Cloud, Dynamics
Available functions
- list project/roles
- create/import/export projects
- validate/publish projects
Installation
To install CLI globally, run the following command:
npm install -g @resconet/woodford-cli
To uninstall CLI, run the following command.
npm uninstall -g @resconet/woodford-cli
Usage
Once installed, you can use the command-line interface by typing wf-cli at the command line.
wf-cli
The supported command-line parameters are described in the npmjs package readme document.