Woodford CLI: Difference between revisions

Latest revision as of 13:42, 12 July 2022

You can control certain functions of Woodford, such as publishing projects, from the command line.

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

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.

@@ Line 1: / Line 1: @@
-{{WIP}}
 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]]
-* Backend: Resco Cloud, Dynamics
+* Supported backends: [[Resco Cloud]], [[Dynamics]]
 == Available functions ==
@@ Line 14: / Line 13: @@
 == Installation ==
-<!--
-It is published in our <s>private</s> <i>public</i> repository yet, so please follow steps to connect to the feed:
+To install CLI globally, run the following command:
- <s>https://dev.azure.com/resconet/MobileCRM/_packaging?_a=connect&feed=resco-npm</s>
+<code>npm install -g @resconet/woodford-cli</code>
- <i>https://www.npmjs.com/package/@resconet/woodford-cli</i>
+To uninstall CLI, run the following command.
-Then run in the project folder:
+<code>npm uninstall -g @resconet/woodford-cli</code>
- npm install woodford-cli -D
-Then you can use it with:
+== Usage ==
- npx wf-cli
-Or install the tool globally:
+Once installed, you can use the command-line interface by typing wf-cli at the command line.
- <s>npm install -g -D woodford-cli --registry https://pkgs.dev.azure.com/resconet/_packaging/resco-npm/npm/registry/</s>
- <i>npm install -g -D woodford-cli --registry  ???</i>
+<code>wf-cli</code>
--->
+The supported command-line parameters are described [https://www.npmjs.com/package/@resconet/woodford-cli in the npmjs package readme document].
 [[Category:Woodford]]