Skip to content

Commit fd93d4c

Browse files
committed
doc updates
1 parent dce853e commit fd93d4c

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

docs/how-to/install-templates.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,24 @@ Templates are stored in this [github prich-templates repository](https://www.git
99
- **List Available Remote Templates for Installation**
1010

1111
```bash
12+
# list all remote templates
1213
prich list --remote
1314
```
1415

1516
```bash
17+
# filter remote templates using tags
1618
prich list --remote --tag code --tag review
1719
```
1820

1921
- **Install Template from *prich-templates* Repository**
2022

2123
```bash
24+
# install in current prich folder
2225
prich install <template_id> --remote
2326
```
2427

2528
```bash
29+
# install in home prich folder
2630
prich install <template_id> --remote --global
2731
```
2832

@@ -47,7 +51,10 @@ This copies files, sets up venvs, and installs dependencies - if python is used
4751
To reinstall template use `--force` flag together with the selected install template, this will reinstall the template and it's isolated venv (if any).
4852
4953
```bash
54+
# from remote repo
5055
prich install code-review --remote --force
56+
# from local folder
5157
prich install ./code-review --force
58+
# from archive file
5259
prich install code-review.zip --force
5360
```

docs/how-to/install.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33

44
Until prich is published on PyPI, you can install it directly from GitHub.
55

6-
**Recommended: Use `pipx`**
6+
**Recommended: Use `pipx`**
7+
> Make sure pipx is installed
8+
> `pip install pipx && pipx ensurepath`
9+
> or
10+
> `brew install pipx && pipx ensurepath`
11+
712
```bash
813
pipx install git+https://github.com/oleks-dev/prich
914
```
10-
1115
> This installs prich in an isolated environment, ideal for CLI tools.
12-
> Make sure pipx is installed (`pip install pipx && pipx ensurepath`).
1316
1417
**Alternative: Use `uv`**
1518
```bash
@@ -44,7 +47,7 @@ pipx install git+https://github.com/oleks-dev/prich --force
4447
### **Initialize prich**
4548
**prich** uses nodejs-like home/local folder configurations for flexible usage of the configs and templates per project.
4649

47-
- Local folder based
50+
- Local (current) folder based
4851
```bash
4952
prich init
5053
```

docs/reference/template/steps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ steps:
7777
##### Extract variables
7878
```yaml
7979
# create variables with extracted text from output
80-
extract_vars: # optional [list[dict]]
80+
extract_variables: # optional [list[dict]]
8181

8282
# extract value using regex
8383
# (same regex rules as in `output_regex`)
@@ -90,7 +90,7 @@ steps:
9090
multiple: false # optional [bool]
9191
```
9292
93-
> **Note:** When extracting variables with `extract_vars` the full initial output text is used (before transformations)
93+
> **Note:** When extracting variables with `extract_variables` the full initial output text is used (before transformations)
9494

9595

9696
##### Validate output

0 commit comments

Comments
 (0)