Jump to content

Woodford CLI: Difference between revisions

From Resco's Wiki
Line 14: Line 14:


== Installation ==
== 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 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 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 here].


[[Category:Woodford]]
[[Category:Woodford]]

Revision as of 05:53, 21 March 2022

Warning Work in progress! We are in the process of updating the information on this page. Subject to change.

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

Prerequisites

  • Minimum version: 15.0
  • Backend: 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 woodford-cli

To uninstall CLI, run the following command.

npm uninstall -g 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 here.