Skip to content

Commit 627f65e

Browse files
committed
Add docs for CLI
1 parent cd90164 commit 627f65e

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

docs/contributing/app-dev.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,20 @@ See [Streamlit's Getting Started guide](https://docs.streamlit.io/getting_starte
1919

2020
## Running CHIME Locally
2121

22+
23+
### With `venv`
24+
25+
```bash
26+
python3 -m venv ~.venv
27+
. ~.venv/bin/activate
28+
pip install -e .
29+
```
30+
2231
### With `pipenv`
2332

2433
```bash
2534
pipenv shell
2635
pipenv sync --dev
27-
PARAMETERS=./defaults/webapp.cfg streamlit run st_app.py
2836
```
2937

3038
### With `conda`
@@ -33,7 +41,24 @@ PARAMETERS=./defaults/webapp.cfg streamlit run st_app.py
3341
conda env create -f environment.yml
3442
source activate chime
3543
pip install streamlit
36-
PARAMETERS=./defaults/webapp.cfg streamlit run st_app.py
44+
```
45+
46+
## Run the Streamlit Web App
47+
48+
```bash
49+
PARAMETERS=-./defaults/webapp.cfg streamlit run st_app.py
50+
```
51+
52+
## Run the Command Line Interface
53+
54+
```bash
55+
PARAMETERS=./defaults/cli.cfg penn_chime
56+
```
57+
58+
## Help with the Command Line Interface
59+
60+
```bash
61+
penn_chime --help
3762
```
3863

3964
### Choosing a Different Set of Parameters

0 commit comments

Comments
 (0)