Woodford CLI
Jump to navigation
Jump to search
Woodford CLI is a command-line tool that allows you to manipulate app projects on remote Resco Cloud or Power Platform servers. It provides a flexible set of commands that help developers speed up the deployment of Woodford projects:
- list project/roles
- create/import/export projects
- validate/publish projects
Find more details in the npmjs package readme document.
Prerequisites
- Minimum version: 15.0
- Supported backends: Resco Cloud, Dynamics
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
Available commands
--help Show help [boolean]
--version Show version number [boolean]
-u, --url Organization url [string]
-l, --login Login [string]
-p, --password Password [string]
-c, --command Command:
[login | logout | list | export | import |
create | publish | delete | roles] project [string] [required]
-n, --name Project name [string]
-f, --file Path to file [string]
-v, --validate Validate published project [boolean]
-r, --properties Command properties
- Create: 'priority;role1,role2,..;appid;version' [string]
-d, --dynamicscrm Dynamics CRM backend [boolean]
-a, --clientid Client ID [string]
-s, --clientsecret Client Secret [string]
Usage
Login (device code flow):
wf-cli -c login -u https://<server>.crm.dynamics.com -l user@example.com
Login (client credentials):
wf-cli -c login -u https://<server>.crm.dynamics.com -a <client_id> -s <client_secret>
Logout:
wf-cli -c logout
List projects:
wf-cli -c list
Create project:
wf-cli -c create -n <project_name> -r "priority;role1,role2,...;appid;version" wf-cli -c create -n "Best Project" -r "1;System Administrator,Sales Person;My First App;v1.0"
Import project:
wf-cli -c import -n <project_name> -f project.woodford
Export project:
wf-cli -c export -n <project_name> -f project.woodford
Publish project:
wf-cli -c publish -n <project_name> [-v]