summaryrefslogtreecommitdiffstats
path: root/docs/config_file.md
blob: 25498c091770993328a4abbb22e3a1e620b886d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
## Config file

- [Example](#example)
- [Location](#location)
- [Creating the file](#creating-the-file)

### Example

An example config can be found by running:

```sh
navi info config-example
```

You can also read it online by clicking [here](./config_file_example.yaml).

### Location

Run the following command to check where the config file is/should be located:

```sh
navi info config-path
```

### Creating the file

Run the following command to generate a config file with the default parameters:

```sh
navi info config-example > "$(navi info config-path)"
```

### Logging

The log file will be created under the same directory where the config locates.

And you can use the `RUST_LOG` env to set the log level, e.g. `RUST_LOG=debug navi`.