definetools
Version:
CLI tools for Define-XML 2.0
110 lines (106 loc) • 4.29 kB
Markdown
definetools
===========
CLI tools for Define-XML 2.0. For interactive review and editing of Define-XML files see [Visual Define-XML Editor](http://defineeditor.com).
# Installation
To use definetools, you need to have [Node.JS](https://nodejs.org/en/download/) installed. Once installed, run
```
npm install -g definetools
```
# Update
Once installed, run one of the following command to update
* Update within minor version (e.g., 0.1.4 -> 0.1.5).
```
npm update -g definetools
```
* Update to the latest version (e.g., 0.1.4-> 0.2.0). There can be backward-incompatible changes in commands.
```
npm install -g definetools@latest
```
# Usage
```
definetools [command] [options] [arguments]
```
# Commands
## getvars
Extract variable attributes from a Define-XML file. See **definetools getvars --help** for more details.
```
definetools getvars [options] xmlFile [output file]
```
#### Options
```
-e, --extended Show an extended list of attributes
-f, --format=csv|json|xlsx [default: csv] Output format
-s, --separate Create a separate CSV file for each dataset
-v, --verbose Show additional information during the execution
--filter=filter Regex used to specify datasets to output. Use --filter='^(ae|cm|lb)$' to select AE, CM, and LB datasets.
--stdout Print results to STDOUT
```
## getdatasets
Extract dataset attributes from a Define-XML file. See **definetools getdatasets --help** for more details.
```
definetools getdatasets [options] xmlFile [output file]
```
#### Options
```
-e, --extended Show an extended list of attributes
-f, --format=csv|json|xlsx [default: csv] Output format
-v, --verbose Show additional information during the execution
--filter=filter Regex used to specify datasets to output. Use --filter='^(ae|cm|lb)$' to select AE, CM, and LB datasets.
--stdout Print results to STDOUT
```
## getcodelists
Extract codelist attributes from a Define-XML file. See **definetools getcodelists --help** for more details.
```
definetools getcodelists [options] xmlFile [output file]
```
#### Options
```
-e, --extended Show extended codelist data
-f, --format=csv|json|xlsx [default: csv] Output format
-v, --verbose Show additional information during the execution
--filter=filter Regex used to filter the output. Use --filter='^(arm|lbtest|aeout)$' to select ARM, LBTEST, and AEOUT codelists.
--stdout Print results to STDOUT
```
## getcodes
Extract code attributes from a Define-XML file. See **definetools getcodes --help** for more details.
```
definetools getcodes [options] xmlFile [output file]
```
#### Options
```
-e, --extended Show an extended list of attributes
-f, --format=csv|json|xlsx [default: csv] Output format
-s, --separate Create a separate file for each codelist
-v, --verbose Show additional information during the execution
--filter=filter Regex used to filter the output. Use --filter='^(arm|lbtest|aeout)$' to select ARM, LBTEST, and AEOUT codelists.
--hideExternal Do not print external codelist information
--onlyExternal Print only external codelist information
--stdout Print results to STDOUT
```
### validate
Validate Define-XML file against XSD schema.
```
definetools validate [options] xmlFile [output file]
```
#### Options
```
-e, --extended Show an extended list of attributes
-f, --format=csv|json|xlsx [default: csv] Output format
-v, --verbose Show additional information during the execution
--defineVersion=2.0.0|2.1.0 Version of the Define-XML schema used for validation.
--encoding=encoding [default: utf8] Input file encoding.
--stdout Print results to STDOUT
```
# Examples
Print an extended list of variable attributes into vars.csv.
```
definetools getvars -e define.xml
```
Print basic dataset attributes to STDOUT
```
definetools getdatasets --stdout define.xml
```
Validate against XSD schema and save to issues.txt in JSON format.
```
definetools validate define.xml issues.txt --format=json
```