Skip to content

Commit a5b9c45

Browse files
committed
documentation for showing config and locating the config
1 parent 2fb9539 commit a5b9c45

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/tutorials/configuration/index.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,35 @@ and some questions will show up:
2929
You could overwrite it or leave it be.
3030
3131
32+
### Show Current Configuration
33+
34+
To inspect the current configuration, use the option `-s` (or `--show`).
35+
36+
```bash
37+
dataherb configure -s
38+
```
39+
40+
We will get something similar to the following.
41+
42+
```bash
43+
The current config for dataherb is:
44+
{
45+
"default": {
46+
"flora": "flora"
47+
},
48+
"workdir": "/Users/itsme/dataherb"
49+
}
50+
The above config is extracted from ~/.dataherb/config.json
51+
```
52+
53+
### Locate the Configuration File
54+
55+
The option `-l` (or `--locate`) opens the folder that contains the configuration file `config.json`.
56+
57+
```bash
58+
dataherb configure -l
59+
```
60+
3261
3362
### Manually Create Configuration
3463

0 commit comments

Comments
 (0)