Skip to content

Commit 22a5eed

Browse files
committed
Update docs lockfile and add settings page
1 parent a55b170 commit 22a5eed

3 files changed

Lines changed: 182 additions & 41 deletions

File tree

docs/docs/settings.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
id: settings
3+
title: Settings
4+
---
5+
6+
`lets` settings control the behavior of `lets` itself.
7+
8+
Use settings for things like colored output or update notifications. Do not use this file for project commands or runtime env. Project behavior still belongs in `lets.yaml`.
9+
10+
## Settings file location
11+
12+
`lets` reads settings from:
13+
14+
```text
15+
~/.config/lets/config.yaml
16+
```
17+
18+
This file is per-user and applies to all projects on the machine.
19+
20+
## Precedence
21+
22+
Settings are resolved in this order:
23+
24+
1. environment variables
25+
2. settings file
26+
3. built-in defaults
27+
28+
This means env vars always win over `config.yaml`.
29+
30+
## Supported settings
31+
32+
### `no_color`
33+
34+
Disable colored output from `lets`.
35+
36+
Example:
37+
38+
```yaml
39+
no_color: true
40+
```
41+
42+
Environment override:
43+
44+
- `NO_COLOR` disables colors even if `no_color` is not set
45+
46+
Note:
47+
48+
- this affects `lets` output itself
49+
- it does not inject `NO_COLOR` into commands from `lets.yaml`
50+
51+
### `upgrade_notify`
52+
53+
Enable or disable background update notifications for interactive sessions.
54+
55+
Example:
56+
57+
```yaml
58+
upgrade_notify: false
59+
```
60+
61+
Environment override:
62+
63+
- `LETS_CHECK_UPDATE` disables update checks and notifications regardless of the settings file
64+
65+
Default:
66+
67+
- `upgrade_notify: true`
68+
69+
## Example
70+
71+
```yaml
72+
no_color: true
73+
upgrade_notify: false
74+
```
75+
76+
## Invalid settings
77+
78+
Unknown keys and invalid YAML cause `lets` startup to fail with an error. Keep this file limited to supported settings only.

0 commit comments

Comments
 (0)