Jump to content

Woodford CLI: Difference between revisions

From Resco's Wiki
Line 29: Line 29:
<code>wf-cli</code>
<code>wf-cli</code>


The supported command-line parameters are described [https://www.npmjs.com/package/@resconet/woodford-cli here].
The supported command-line parameters are described [https://www.npmjs.com/package/@resconet/woodford-cli in the npmjs package description].


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

Revision as of 05:58, 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 in the npmjs package description.