@@ -8,15 +8,17 @@ We provide a command line interface to run [JSPython](https://github.com/jspytho
88 npm install -g jspython-cli
99```
1010
11- ## Run in terminal
11+ ## Usage
12+
13+ ### Run in terminal
1214```
1315 jspython path/to/jspython/file
1416 jspython --file path/to/jspython/file
1517 jspython --file=test.jspy
1618
1719```
1820
19- ## Pass parameters to script
21+ ### Pass parameters to script
2022In CLI
2123```
2224jspython --file=path/to/jspython/file --param1=value --param
@@ -28,17 +30,17 @@ params("param1") == "value" # true
2830params(" param" ) == false # true
2931```
3032
31- ## Run file
33+ ### Run file
3234```
3335jspython --file=path/to/jspython/file.jspy
3436```
3537
36- ## Run file and log into file
38+ ### Run file and log into file
3739```
3840jspython --file=path/to/jspython/file.jspy --output=path/to/log.txt
3941```
4042
41- ## Run specific function from the file
43+ ### Run specific function from the file
4244```
4345jspython --file=path/to/jspython/file.jspy --entryFunction=myFunc1
4446```
@@ -49,11 +51,11 @@ jspython -f=path/to/jspython/file.jspy -e=myFunc1
4951
5052
5153
52- ## Run file when you have your source code in a nested folder
54+ ### Run file when you have your source code in a nested folder
5355```
5456jspython --file=path/to/jspython/file.jspy --srcRoot=src
5557```
56- In this case it expects package.json and node_modules on the root level
58+ Normally you would expect package.json and node_modules to be in the root level and all scripts in the ` src ` folder
5759
5860```
5961-|- .git
@@ -62,7 +64,7 @@ In this case it expects package.json and node_modules on the root level
6264-|- .ws
6365-|- node_modules
6466-|- src
65- -|-my_code.jspy
67+ -|- my_code.jspy
6668-|- package.json
6769```
6870
7476> jspython -f=my_code.jspy -s=src --param1=some_Value
7577
7678
77- ## Show version
79+ ### Version info
7880
7981> jspython -v
8082
0 commit comments