@narumitw/pi-starship 0.52.3 → 0.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -622
- package/dist/chunks/{chunk-6D6VEVE5.js → chunk-UX6PBXVK.js} +125 -26
- package/dist/chunks/chunk-UX6PBXVK.js.map +7 -0
- package/dist/chunks/{cloud-GEBXIN43.js → cloud-BKHYWCTA.js} +3 -3
- package/dist/chunks/cloud-BKHYWCTA.js.map +7 -0
- package/dist/chunks/{commands-T73QN435.js → commands-53ZO2JUK.js} +3 -2
- package/dist/chunks/{commands-T73QN435.js.map → commands-53ZO2JUK.js.map} +2 -2
- package/dist/chunks/{development-TOXV7LWE.js → development-BERD42HW.js} +2 -2
- package/dist/chunks/{development-TOXV7LWE.js.map → development-BERD42HW.js.map} +2 -2
- package/dist/chunks/{execution-QDYHQKST.js → execution-42JTEY3N.js} +2 -2
- package/dist/chunks/{execution-QDYHQKST.js.map → execution-42JTEY3N.js.map} +2 -2
- package/dist/chunks/{languages-QR3XPRVQ.js → languages-RMP6DW7H.js} +2 -2
- package/dist/chunks/languages-RMP6DW7H.js.map +7 -0
- package/dist/index.ts +31 -10
- package/dist/index.ts.map +3 -3
- package/package.json +14 -12
- package/skills/configuring-pi-starship/SKILL.md +113 -0
- package/skills/configuring-pi-starship/references/configuration.md +365 -0
- package/skills/configuring-pi-starship/references/module-catalog.md +978 -0
- package/skills/configuring-pi-starship/references/modules.md +230 -0
- package/skills/configuring-pi-starship/references/runtime-and-security.md +213 -0
- package/skills/configuring-pi-starship/scripts/apply.mjs +64 -0
- package/skills/configuring-pi-starship/scripts/config-path.mjs +11 -0
- package/skills/configuring-pi-starship/scripts/script-support.mjs +20 -0
- package/skills/configuring-pi-starship/scripts/validate.mjs +30 -0
- package/src/config.ts +9 -0
- package/src/effective-config.ts +1 -0
- package/src/format/style.ts +14 -6
- package/src/modules/activity.ts +57 -4
- package/src/modules/catalog.ts +2 -2
- package/src/modules/provider.ts +19 -1
- package/src/modules/render.ts +2 -1
- package/src/modules/thinking.ts +24 -0
- package/src/modules/types.ts +3 -0
- package/src/pi-starship.ts +24 -3
- package/src/runtime/cloud.ts +3 -2
- package/src/runtime/development.ts +1 -1
- package/src/runtime/execution.ts +1 -1
- package/src/runtime/github-pr.ts +2 -1
- package/src/runtime/languages.ts +1 -1
- package/dist/chunks/chunk-6D6VEVE5.js.map +0 -7
- package/dist/chunks/cloud-GEBXIN43.js.map +0 -7
- package/dist/chunks/languages-QR3XPRVQ.js.map +0 -7
|
@@ -0,0 +1,978 @@
|
|
|
1
|
+
# Complete Module Configuration Catalog
|
|
2
|
+
|
|
3
|
+
Use this authoritative public reference for exact module names, format variables, defaults, accepted style fields, display rules, option types, ranges, and enum values.
|
|
4
|
+
|
|
5
|
+
The catalog order is also the `$all` expansion order.
|
|
6
|
+
|
|
7
|
+
## Shared module fields
|
|
8
|
+
|
|
9
|
+
Every `[module]` table accepts these fields:
|
|
10
|
+
|
|
11
|
+
| Field | Type | Behavior |
|
|
12
|
+
| --- | --- | --- |
|
|
13
|
+
| `format` | string | Module-local format parsed with only the module's listed format and style variables. |
|
|
14
|
+
| `symbol` | string | Value supplied as `$symbol`; an empty string hides only the symbol. |
|
|
15
|
+
| `disabled` | boolean | Removes the module from direct root references and `$all` when `true`. |
|
|
16
|
+
|
|
17
|
+
Most modules also accept `style` as listed below.
|
|
18
|
+
Modules with state-selected or multiple style fields list those exact fields instead.
|
|
19
|
+
Unknown fields warn and remain inactive.
|
|
20
|
+
A wrong type or out-of-range option warns and uses that field's default.
|
|
21
|
+
|
|
22
|
+
String maps require string values.
|
|
23
|
+
String arrays require non-empty strings.
|
|
24
|
+
Language detection arrays allow a leading `!` rejection rule, while other string arrays reject negated entries.
|
|
25
|
+
All enum values are case-sensitive.
|
|
26
|
+
|
|
27
|
+
## Catalog order
|
|
28
|
+
|
|
29
|
+
`brand` → `provider` → `model` → `thinking` → `directory` → `git_worktree` → `git_branch` → `github_pr` → `git_commit` → `git_state` → `git_metrics` → `git_status` → `package` → `nodejs` → `python` → `rust` → `golang` → `bun` → `deno` → `mise` → `direnv` → `conda` → `pixi` → `nix_shell` → `guix_shell` → `docker_context` → `kubernetes` → `terraform` → `aws` → `gcloud` → `azure` → `openstack` → `os` → `container` → `hostname` → `username` → `activity` → `context` → `tokens` → `cache` → `cost` → `time` → `turn` → `fill` → `extension_status`
|
|
30
|
+
|
|
31
|
+
## Module schemas
|
|
32
|
+
|
|
33
|
+
### `brand`
|
|
34
|
+
|
|
35
|
+
pi-starship brand mark.
|
|
36
|
+
|
|
37
|
+
- Format variables: `$symbol`.
|
|
38
|
+
- Style variables in `format`: `$style`.
|
|
39
|
+
- Default `format`: `"[ $symbol ]($style)"`.
|
|
40
|
+
- Default `symbol`: `"π"`.
|
|
41
|
+
- Default `disabled`: `false`.
|
|
42
|
+
|
|
43
|
+
Accepted style fields:
|
|
44
|
+
|
|
45
|
+
| Field | Default |
|
|
46
|
+
| --- | --- |
|
|
47
|
+
| `style` | `"bold white"` |
|
|
48
|
+
|
|
49
|
+
### `provider`
|
|
50
|
+
|
|
51
|
+
Current Pi model provider.
|
|
52
|
+
|
|
53
|
+
- Format variables: `$symbol`, `$provider`.
|
|
54
|
+
- Style variables in `format`: `$style`.
|
|
55
|
+
- Default `format`: `"[$symbol $provider ]($style)"`.
|
|
56
|
+
- Default `symbol`: `"🔌"`.
|
|
57
|
+
- Default `disabled`: `false`.
|
|
58
|
+
|
|
59
|
+
Accepted style fields:
|
|
60
|
+
|
|
61
|
+
| Field | Default |
|
|
62
|
+
| --- | --- |
|
|
63
|
+
| `style` | `"bold blue"` |
|
|
64
|
+
|
|
65
|
+
Additional options:
|
|
66
|
+
|
|
67
|
+
| Option | Type | Default | Constraints and meaning |
|
|
68
|
+
| --- | --- | --- | --- |
|
|
69
|
+
| `provider_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact provider-name to display-label replacements; an empty replacement hides only the provider text. |
|
|
70
|
+
|
|
71
|
+
### `model`
|
|
72
|
+
|
|
73
|
+
Current Pi model.
|
|
74
|
+
|
|
75
|
+
- Format variables: `$symbol`, `$model`.
|
|
76
|
+
- Style variables in `format`: `$style`.
|
|
77
|
+
- Default `format`: `"[$symbol $model ]($style)"`.
|
|
78
|
+
- Default `symbol`: `"🤖"`.
|
|
79
|
+
- Default `disabled`: `false`.
|
|
80
|
+
|
|
81
|
+
Accepted style fields:
|
|
82
|
+
|
|
83
|
+
| Field | Default |
|
|
84
|
+
| --- | --- |
|
|
85
|
+
| `style` | `"bold blue"` |
|
|
86
|
+
|
|
87
|
+
Additional options:
|
|
88
|
+
|
|
89
|
+
| Option | Type | Default | Constraints and meaning |
|
|
90
|
+
| --- | --- | --- | --- |
|
|
91
|
+
| `truncation_length` | integer | `0` | Inclusive range 0 through 1000. Maximum retained model-label grapheme clusters; zero disables truncation. |
|
|
92
|
+
| `truncation_symbol` | string | `"…"` | May be empty. Marker placed at the removed start, middle, or end; an empty string removes text without a marker. |
|
|
93
|
+
| `truncation_direction` | string enum | `"end"` | One of `start`, `middle`, `end`. Which part of the model label is removed when truncating. |
|
|
94
|
+
| `model_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact model-ID replacements that bypass built-in Claude/GPT shortening and are then subject to configured truncation. |
|
|
95
|
+
|
|
96
|
+
### `thinking`
|
|
97
|
+
|
|
98
|
+
Current Pi thinking level or streaming state.
|
|
99
|
+
|
|
100
|
+
- Format variables: `$symbol`, `$level`.
|
|
101
|
+
- Style variables in `format`: `$style`.
|
|
102
|
+
- Default `format`: `"[$symbol $level ]($style)"`.
|
|
103
|
+
- Default `symbol`: `"🧠"`.
|
|
104
|
+
- Default `disabled`: `false`.
|
|
105
|
+
|
|
106
|
+
Accepted style fields:
|
|
107
|
+
|
|
108
|
+
| Field | Default |
|
|
109
|
+
| --- | --- |
|
|
110
|
+
| `style` | `"bold purple"` |
|
|
111
|
+
| `style_off` | `""` |
|
|
112
|
+
| `style_minimal` | `""` |
|
|
113
|
+
| `style_low` | `""` |
|
|
114
|
+
| `style_medium` | `""` |
|
|
115
|
+
| `style_high` | `""` |
|
|
116
|
+
| `style_xhigh` | `""` |
|
|
117
|
+
| `style_max` | `""` |
|
|
118
|
+
|
|
119
|
+
### `directory`
|
|
120
|
+
|
|
121
|
+
Current working directory.
|
|
122
|
+
|
|
123
|
+
- Format variables: `$symbol`, `$path`, `$full_path`.
|
|
124
|
+
- Style variables in `format`: `$style`.
|
|
125
|
+
- Default `format`: `"[ $symbol $path ]($style)"`.
|
|
126
|
+
- Default `symbol`: `"📁"`.
|
|
127
|
+
- Default `disabled`: `false`.
|
|
128
|
+
|
|
129
|
+
Accepted style fields:
|
|
130
|
+
|
|
131
|
+
| Field | Default |
|
|
132
|
+
| --- | --- |
|
|
133
|
+
| `style` | `"cyan bold"` |
|
|
134
|
+
|
|
135
|
+
Additional options:
|
|
136
|
+
|
|
137
|
+
| Option | Type | Default | Constraints and meaning |
|
|
138
|
+
| --- | --- | --- | --- |
|
|
139
|
+
| `truncation_length` | integer | `3` | Inclusive range 0 through 1000000. Number of trailing path components retained; zero keeps every component. |
|
|
140
|
+
| `truncate_to_repo` | boolean | `true` | Contracts the displayed path relative to the current Git repository root before component truncation. |
|
|
141
|
+
| `fish_style_pwd_dir_length` | integer | `0` | Inclusive range 0 through 1000. Abbreviates otherwise omitted parent components to this many grapheme clusters when no substitution is configured. |
|
|
142
|
+
| `truncation_symbol` | string | `""` | May be empty. Prefix placed before a contracted or component-truncated path when fish-style abbreviation is inactive. |
|
|
143
|
+
| `home_symbol` | string | `"~"` | May be empty. Replacement for the current user's home-directory prefix. |
|
|
144
|
+
| `use_os_path_sep` | boolean | `true` | Uses the platform path separator instead of always rendering `/`. |
|
|
145
|
+
| `substitutions` | string-to-string table | `{}` | Keys and values are strings. Ordered literal replacements applied to the home- or repository-contracted display path before component truncation. |
|
|
146
|
+
|
|
147
|
+
### `git_worktree`
|
|
148
|
+
|
|
149
|
+
Current linked Git worktree identity.
|
|
150
|
+
|
|
151
|
+
- Format variables: `$symbol`, `$name`, `$path`.
|
|
152
|
+
- Style variables in `format`: `$style`.
|
|
153
|
+
- Default `format`: `"[ $symbol $name ]($style)"`.
|
|
154
|
+
- Default `symbol`: `"🌳"`.
|
|
155
|
+
- Default `disabled`: `false`.
|
|
156
|
+
|
|
157
|
+
Accepted style fields:
|
|
158
|
+
|
|
159
|
+
| Field | Default |
|
|
160
|
+
| --- | --- |
|
|
161
|
+
| `style` | `"cyan bold"` |
|
|
162
|
+
|
|
163
|
+
### `git_branch`
|
|
164
|
+
|
|
165
|
+
Current Git branch and upstream identity.
|
|
166
|
+
|
|
167
|
+
- Format variables: `$symbol`, `$branch`, `$remote_name`, `$remote_branch`.
|
|
168
|
+
- Style variables in `format`: `$style`.
|
|
169
|
+
- Default `format`: `"[ $symbol $branch ]($style)"`.
|
|
170
|
+
- Default `symbol`: `"🌿"`.
|
|
171
|
+
- Default `disabled`: `false`.
|
|
172
|
+
|
|
173
|
+
Accepted style fields:
|
|
174
|
+
|
|
175
|
+
| Field | Default |
|
|
176
|
+
| --- | --- |
|
|
177
|
+
| `style` | `"bold purple"` |
|
|
178
|
+
|
|
179
|
+
Additional options:
|
|
180
|
+
|
|
181
|
+
| Option | Type | Default | Constraints and meaning |
|
|
182
|
+
| --- | --- | --- | --- |
|
|
183
|
+
| `truncation_length` | integer | `0` | Inclusive range 0 through 1000000. Grapheme clusters retained independently for branch and remote labels; zero disables truncation. |
|
|
184
|
+
| `truncation_symbol` | string | `"…"` | May be empty. Its first grapheme is appended to each truncated branch or remote label. |
|
|
185
|
+
|
|
186
|
+
### `github_pr`
|
|
187
|
+
|
|
188
|
+
Current branch's GitHub pull request state, checks, and review.
|
|
189
|
+
|
|
190
|
+
- Format variables: `$symbol`, `$number`, `$link`, `$state`, `$checks`, `$review`, `$status`.
|
|
191
|
+
- Style variables in `format`: `$style`.
|
|
192
|
+
- Default `format`: `"[ $symbol$link( · $status) ]($style)"`.
|
|
193
|
+
- Default `symbol`: `"PR "`.
|
|
194
|
+
- Default `disabled`: `false`.
|
|
195
|
+
|
|
196
|
+
Accepted style fields:
|
|
197
|
+
|
|
198
|
+
| Field | Default |
|
|
199
|
+
| --- | --- |
|
|
200
|
+
| `style` | `"bold blue"` |
|
|
201
|
+
|
|
202
|
+
### `git_commit`
|
|
203
|
+
|
|
204
|
+
Current Git commit hash or tag.
|
|
205
|
+
|
|
206
|
+
- Format variables: `$symbol`, `$hash`, `$tag`.
|
|
207
|
+
- Style variables in `format`: `$style`.
|
|
208
|
+
- Default `format`: `"[ ($hash) ]($style)"`.
|
|
209
|
+
- Default `symbol`: `""`.
|
|
210
|
+
- Default `disabled`: `false`.
|
|
211
|
+
|
|
212
|
+
Accepted style fields:
|
|
213
|
+
|
|
214
|
+
| Field | Default |
|
|
215
|
+
| --- | --- |
|
|
216
|
+
| `style` | `"green bold"` |
|
|
217
|
+
|
|
218
|
+
Additional options:
|
|
219
|
+
|
|
220
|
+
| Option | Type | Default | Constraints and meaning |
|
|
221
|
+
| --- | --- | --- | --- |
|
|
222
|
+
| `commit_hash_length` | integer | `7` | Inclusive range 0 through 64. Maximum commit-hash characters retained from the collected HEAD hash. |
|
|
223
|
+
|
|
224
|
+
### `git_state`
|
|
225
|
+
|
|
226
|
+
Current Git operation such as merge, rebase, or cherry-pick.
|
|
227
|
+
|
|
228
|
+
- Format variables: `$symbol`, `$state`, `$progress_current`, `$progress_total`.
|
|
229
|
+
- Style variables in `format`: `$style`.
|
|
230
|
+
- Default `format`: `"[ ($state( $progress_current/$progress_total)) ]($style)"`.
|
|
231
|
+
- Default `symbol`: `""`.
|
|
232
|
+
- Default `disabled`: `false`.
|
|
233
|
+
|
|
234
|
+
Accepted style fields:
|
|
235
|
+
|
|
236
|
+
| Field | Default |
|
|
237
|
+
| --- | --- |
|
|
238
|
+
| `style` | `"bold yellow"` |
|
|
239
|
+
|
|
240
|
+
### `git_metrics`
|
|
241
|
+
|
|
242
|
+
Added and deleted lines in the current Git worktree.
|
|
243
|
+
|
|
244
|
+
- Format variables: `$symbol`, `$added`, `$deleted`.
|
|
245
|
+
- Style variables in `format`: `$added_style`, `$deleted_style`.
|
|
246
|
+
- Default `format`: `"([+$added]($added_style) )([-$deleted]($deleted_style) )"`.
|
|
247
|
+
- Default `symbol`: `""`.
|
|
248
|
+
- Default `disabled`: `true`.
|
|
249
|
+
|
|
250
|
+
Accepted style fields:
|
|
251
|
+
|
|
252
|
+
| Field | Default |
|
|
253
|
+
| --- | --- |
|
|
254
|
+
| `added_style` | `"bold green"` |
|
|
255
|
+
| `deleted_style` | `"bold red"` |
|
|
256
|
+
|
|
257
|
+
### `git_status`
|
|
258
|
+
|
|
259
|
+
Current Git worktree and index status summary.
|
|
260
|
+
|
|
261
|
+
- Format variables: `$symbol`, `$all_status`, `$ahead_behind`, `$ahead`, `$behind`, `$up_to_date`, `$diverged`, `$conflicted`, `$stashed`, `$deleted`, `$renamed`, `$modified`, `$typechanged`, `$staged`, `$untracked`, `$worktree_added`, `$worktree_deleted`, `$worktree_modified`, `$worktree_typechanged`, `$index_added`, `$index_deleted`, `$index_modified`, `$index_typechanged`.
|
|
262
|
+
- Style variables in `format`: `$style`.
|
|
263
|
+
- Default `format`: `"[$all_status( $ahead_behind) ]($style)"`.
|
|
264
|
+
- Default `symbol`: `""`.
|
|
265
|
+
- Default `disabled`: `false`.
|
|
266
|
+
|
|
267
|
+
Accepted style fields:
|
|
268
|
+
|
|
269
|
+
| Field | Default |
|
|
270
|
+
| --- | --- |
|
|
271
|
+
| `style` | `"red bold"` |
|
|
272
|
+
|
|
273
|
+
### `package`
|
|
274
|
+
|
|
275
|
+
Current workspace package version and manifest source.
|
|
276
|
+
|
|
277
|
+
- Format variables: `$symbol`, `$version`, `$source`.
|
|
278
|
+
- Style variables in `format`: `$style`.
|
|
279
|
+
- Default `format`: `"via [$symbol$version]($style) "`.
|
|
280
|
+
- Default `symbol`: `"📦 "`.
|
|
281
|
+
- Default `disabled`: `false`.
|
|
282
|
+
|
|
283
|
+
Accepted style fields:
|
|
284
|
+
|
|
285
|
+
| Field | Default |
|
|
286
|
+
| --- | --- |
|
|
287
|
+
| `style` | `"bold 208"` |
|
|
288
|
+
|
|
289
|
+
Additional options:
|
|
290
|
+
|
|
291
|
+
| Option | Type | Default | Constraints and meaning |
|
|
292
|
+
| --- | --- | --- | --- |
|
|
293
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
294
|
+
|
|
295
|
+
### `nodejs`
|
|
296
|
+
|
|
297
|
+
Node.js version detected in the current workspace.
|
|
298
|
+
|
|
299
|
+
- Format variables: `$symbol`, `$version`, `$engines_version`.
|
|
300
|
+
- Style variables in `format`: `$style`.
|
|
301
|
+
- Default `format`: `"via [$symbol($version )]($style)"`.
|
|
302
|
+
- Default `symbol`: `" "`.
|
|
303
|
+
- Default `disabled`: `false`.
|
|
304
|
+
|
|
305
|
+
Accepted style fields:
|
|
306
|
+
|
|
307
|
+
| Field | Default |
|
|
308
|
+
| --- | --- |
|
|
309
|
+
| `style` | `"bold green"` |
|
|
310
|
+
|
|
311
|
+
Additional options:
|
|
312
|
+
|
|
313
|
+
| Option | Type | Default | Constraints and meaning |
|
|
314
|
+
| --- | --- | --- | --- |
|
|
315
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
316
|
+
| `detect_files` | string array | `[]` | Entries may start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
317
|
+
| `detect_extensions` | string array | `[]` | Entries may start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
318
|
+
| `detect_folders` | string array | `[]` | Entries may start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
319
|
+
|
|
320
|
+
### `python`
|
|
321
|
+
|
|
322
|
+
Python version, virtual environment, and pyenv state.
|
|
323
|
+
|
|
324
|
+
- Format variables: `$symbol`, `$version`, `$virtualenv`, `$pyenv_prefix`.
|
|
325
|
+
- Style variables in `format`: `$style`.
|
|
326
|
+
- Default `format`: `"via [$symbol$pyenv_prefix($version )(\\($virtualenv\\) )]($style)"`.
|
|
327
|
+
- Default `symbol`: `" "`.
|
|
328
|
+
- Default `disabled`: `false`.
|
|
329
|
+
|
|
330
|
+
Accepted style fields:
|
|
331
|
+
|
|
332
|
+
| Field | Default |
|
|
333
|
+
| --- | --- |
|
|
334
|
+
| `style` | `"yellow bold"` |
|
|
335
|
+
|
|
336
|
+
Additional options:
|
|
337
|
+
|
|
338
|
+
| Option | Type | Default | Constraints and meaning |
|
|
339
|
+
| --- | --- | --- | --- |
|
|
340
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
341
|
+
| `detect_files` | string array | `[]` | Entries may start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
342
|
+
| `detect_extensions` | string array | `[]` | Entries may start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
343
|
+
| `detect_folders` | string array | `[]` | Entries may start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
344
|
+
|
|
345
|
+
### `rust`
|
|
346
|
+
|
|
347
|
+
Rust toolchain detected in the current workspace.
|
|
348
|
+
|
|
349
|
+
- Format variables: `$symbol`, `$version`, `$numver`, `$toolchain`.
|
|
350
|
+
- Style variables in `format`: `$style`.
|
|
351
|
+
- Default `format`: `"via [$symbol($version )]($style)"`.
|
|
352
|
+
- Default `symbol`: `" "`.
|
|
353
|
+
- Default `disabled`: `false`.
|
|
354
|
+
|
|
355
|
+
Accepted style fields:
|
|
356
|
+
|
|
357
|
+
| Field | Default |
|
|
358
|
+
| --- | --- |
|
|
359
|
+
| `style` | `"bold red"` |
|
|
360
|
+
|
|
361
|
+
Additional options:
|
|
362
|
+
|
|
363
|
+
| Option | Type | Default | Constraints and meaning |
|
|
364
|
+
| --- | --- | --- | --- |
|
|
365
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
366
|
+
| `detect_files` | string array | `[]` | Entries may start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
367
|
+
| `detect_extensions` | string array | `[]` | Entries may start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
368
|
+
| `detect_folders` | string array | `[]` | Entries may start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
369
|
+
|
|
370
|
+
### `golang`
|
|
371
|
+
|
|
372
|
+
Go version detected in the current workspace.
|
|
373
|
+
|
|
374
|
+
- Format variables: `$symbol`, `$version`, `$mod_version`.
|
|
375
|
+
- Style variables in `format`: `$style`.
|
|
376
|
+
- Default `format`: `"via [$symbol($version )]($style)"`.
|
|
377
|
+
- Default `symbol`: `" "`.
|
|
378
|
+
- Default `disabled`: `false`.
|
|
379
|
+
|
|
380
|
+
Accepted style fields:
|
|
381
|
+
|
|
382
|
+
| Field | Default |
|
|
383
|
+
| --- | --- |
|
|
384
|
+
| `style` | `"bold cyan"` |
|
|
385
|
+
|
|
386
|
+
Additional options:
|
|
387
|
+
|
|
388
|
+
| Option | Type | Default | Constraints and meaning |
|
|
389
|
+
| --- | --- | --- | --- |
|
|
390
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
391
|
+
| `detect_files` | string array | `[]` | Entries may start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
392
|
+
| `detect_extensions` | string array | `[]` | Entries may start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
393
|
+
| `detect_folders` | string array | `[]` | Entries may start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
394
|
+
|
|
395
|
+
### `bun`
|
|
396
|
+
|
|
397
|
+
Bun version detected in the current workspace.
|
|
398
|
+
|
|
399
|
+
- Format variables: `$symbol`, `$version`.
|
|
400
|
+
- Style variables in `format`: `$style`.
|
|
401
|
+
- Default `format`: `"via [$symbol($version )]($style)"`.
|
|
402
|
+
- Default `symbol`: `"🍞 "`.
|
|
403
|
+
- Default `disabled`: `false`.
|
|
404
|
+
|
|
405
|
+
Accepted style fields:
|
|
406
|
+
|
|
407
|
+
| Field | Default |
|
|
408
|
+
| --- | --- |
|
|
409
|
+
| `style` | `"bold red"` |
|
|
410
|
+
|
|
411
|
+
Additional options:
|
|
412
|
+
|
|
413
|
+
| Option | Type | Default | Constraints and meaning |
|
|
414
|
+
| --- | --- | --- | --- |
|
|
415
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
416
|
+
| `detect_files` | string array | `[]` | Entries may start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
417
|
+
| `detect_extensions` | string array | `[]` | Entries may start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
418
|
+
| `detect_folders` | string array | `[]` | Entries may start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
419
|
+
|
|
420
|
+
### `deno`
|
|
421
|
+
|
|
422
|
+
Deno version detected in the current workspace.
|
|
423
|
+
|
|
424
|
+
- Format variables: `$symbol`, `$version`.
|
|
425
|
+
- Style variables in `format`: `$style`.
|
|
426
|
+
- Default `format`: `"via [$symbol($version )]($style)"`.
|
|
427
|
+
- Default `symbol`: `"🦕 "`.
|
|
428
|
+
- Default `disabled`: `false`.
|
|
429
|
+
|
|
430
|
+
Accepted style fields:
|
|
431
|
+
|
|
432
|
+
| Field | Default |
|
|
433
|
+
| --- | --- |
|
|
434
|
+
| `style` | `"green bold"` |
|
|
435
|
+
|
|
436
|
+
Additional options:
|
|
437
|
+
|
|
438
|
+
| Option | Type | Default | Constraints and meaning |
|
|
439
|
+
| --- | --- | --- | --- |
|
|
440
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
441
|
+
| `detect_files` | string array | `[]` | Entries may start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
442
|
+
| `detect_extensions` | string array | `[]` | Entries may start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
443
|
+
| `detect_folders` | string array | `[]` | Entries may start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
444
|
+
|
|
445
|
+
### `mise`
|
|
446
|
+
|
|
447
|
+
Current mise configuration health.
|
|
448
|
+
|
|
449
|
+
- Format variables: `$symbol`, `$health`.
|
|
450
|
+
- Style variables in `format`: `$style`.
|
|
451
|
+
- Default `format`: `"via [$symbol$health]($style) "`.
|
|
452
|
+
- Default `symbol`: `"mise "`.
|
|
453
|
+
- Default `disabled`: `false`.
|
|
454
|
+
|
|
455
|
+
Accepted style fields:
|
|
456
|
+
|
|
457
|
+
| Field | Default |
|
|
458
|
+
| --- | --- |
|
|
459
|
+
| `style` | `"bold purple"` |
|
|
460
|
+
|
|
461
|
+
Additional options:
|
|
462
|
+
|
|
463
|
+
| Option | Type | Default | Constraints and meaning |
|
|
464
|
+
| --- | --- | --- | --- |
|
|
465
|
+
| `detect_files` | string array | `[]` | Entries may not start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
466
|
+
| `detect_extensions` | string array | `[]` | Entries may not start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
467
|
+
| `detect_folders` | string array | `[]` | Entries may not start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
468
|
+
|
|
469
|
+
### `direnv`
|
|
470
|
+
|
|
471
|
+
Current direnv loading and permission state.
|
|
472
|
+
|
|
473
|
+
- Format variables: `$symbol`, `$rc_path`, `$allowed`, `$loaded`.
|
|
474
|
+
- Style variables in `format`: `$style`.
|
|
475
|
+
- Default `format`: `"[$symbol$loaded]($style) "`.
|
|
476
|
+
- Default `symbol`: `"direnv "`.
|
|
477
|
+
- Default `disabled`: `false`.
|
|
478
|
+
|
|
479
|
+
Accepted style fields:
|
|
480
|
+
|
|
481
|
+
| Field | Default |
|
|
482
|
+
| --- | --- |
|
|
483
|
+
| `style` | `"bold bright-yellow"` |
|
|
484
|
+
|
|
485
|
+
Additional options:
|
|
486
|
+
|
|
487
|
+
| Option | Type | Default | Constraints and meaning |
|
|
488
|
+
| --- | --- | --- | --- |
|
|
489
|
+
| `detect_files` | string array | `[]` | Entries may not start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
490
|
+
| `detect_extensions` | string array | `[]` | Entries may not start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
491
|
+
| `detect_folders` | string array | `[]` | Entries may not start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
492
|
+
|
|
493
|
+
### `conda`
|
|
494
|
+
|
|
495
|
+
Active Conda environment.
|
|
496
|
+
|
|
497
|
+
- Format variables: `$symbol`, `$environment`.
|
|
498
|
+
- Style variables in `format`: `$style`.
|
|
499
|
+
- Default `format`: `"via [$symbol$environment]($style) "`.
|
|
500
|
+
- Default `symbol`: `"🅒 "`.
|
|
501
|
+
- Default `disabled`: `false`.
|
|
502
|
+
|
|
503
|
+
Accepted style fields:
|
|
504
|
+
|
|
505
|
+
| Field | Default |
|
|
506
|
+
| --- | --- |
|
|
507
|
+
| `style` | `"green bold"` |
|
|
508
|
+
|
|
509
|
+
Additional options:
|
|
510
|
+
|
|
511
|
+
| Option | Type | Default | Constraints and meaning |
|
|
512
|
+
| --- | --- | --- | --- |
|
|
513
|
+
| `ignore_base` | boolean | `true` | Hides the Conda module when `CONDA_DEFAULT_ENV` is exactly `base`. |
|
|
514
|
+
| `truncation_length` | integer | `1` | Inclusive range 0 through 1000000. Number of trailing environment-path components retained; zero keeps the complete value. |
|
|
515
|
+
|
|
516
|
+
### `pixi`
|
|
517
|
+
|
|
518
|
+
Active Pixi environment and project.
|
|
519
|
+
|
|
520
|
+
- Format variables: `$symbol`, `$version`, `$environment`, `$project_name`.
|
|
521
|
+
- Style variables in `format`: `$style`.
|
|
522
|
+
- Default `format`: `"via [$symbol$environment]($style) "`.
|
|
523
|
+
- Default `symbol`: `"🧚 "`.
|
|
524
|
+
- Default `disabled`: `false`.
|
|
525
|
+
|
|
526
|
+
Accepted style fields:
|
|
527
|
+
|
|
528
|
+
| Field | Default |
|
|
529
|
+
| --- | --- |
|
|
530
|
+
| `style` | `"yellow bold"` |
|
|
531
|
+
|
|
532
|
+
Additional options:
|
|
533
|
+
|
|
534
|
+
| Option | Type | Default | Constraints and meaning |
|
|
535
|
+
| --- | --- | --- | --- |
|
|
536
|
+
| `detect_files` | string array | `[]` | Entries may not start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
537
|
+
| `detect_extensions` | string array | `[]` | Entries may not start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
538
|
+
| `detect_folders` | string array | `[]` | Entries may not start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
539
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
540
|
+
| `show_default_environment` | boolean | `false` | Shows Pixi's environment when its name is exactly `default`. |
|
|
541
|
+
|
|
542
|
+
### `nix_shell`
|
|
543
|
+
|
|
544
|
+
Current Nix shell state, name, and nesting level.
|
|
545
|
+
|
|
546
|
+
- Format variables: `$symbol`, `$state`, `$name`, `$level`.
|
|
547
|
+
- Style variables in `format`: `$style`.
|
|
548
|
+
- Default `format`: `"via [$symbol$state( \\($name\\))]($style) "`.
|
|
549
|
+
- Default `symbol`: `" "`.
|
|
550
|
+
- Default `disabled`: `false`.
|
|
551
|
+
|
|
552
|
+
Accepted style fields:
|
|
553
|
+
|
|
554
|
+
| Field | Default |
|
|
555
|
+
| --- | --- |
|
|
556
|
+
| `style` | `"bold blue"` |
|
|
557
|
+
|
|
558
|
+
### `guix_shell`
|
|
559
|
+
|
|
560
|
+
Current Guix shell state.
|
|
561
|
+
|
|
562
|
+
- Format variables: `$symbol`, `$state`.
|
|
563
|
+
- Style variables in `format`: `$style`.
|
|
564
|
+
- Default `format`: `"via [$symbol]($style) "`.
|
|
565
|
+
- Default `symbol`: `"🐃 "`.
|
|
566
|
+
- Default `disabled`: `false`.
|
|
567
|
+
|
|
568
|
+
Accepted style fields:
|
|
569
|
+
|
|
570
|
+
| Field | Default |
|
|
571
|
+
| --- | --- |
|
|
572
|
+
| `style` | `"yellow bold"` |
|
|
573
|
+
|
|
574
|
+
### `docker_context`
|
|
575
|
+
|
|
576
|
+
Active Docker context.
|
|
577
|
+
|
|
578
|
+
- Format variables: `$symbol`, `$context`.
|
|
579
|
+
- Style variables in `format`: `$style`.
|
|
580
|
+
- Default `format`: `"via [$symbol$context]($style) "`.
|
|
581
|
+
- Default `symbol`: `" "`.
|
|
582
|
+
- Default `disabled`: `false`.
|
|
583
|
+
|
|
584
|
+
Accepted style fields:
|
|
585
|
+
|
|
586
|
+
| Field | Default |
|
|
587
|
+
| --- | --- |
|
|
588
|
+
| `style` | `"blue bold"` |
|
|
589
|
+
|
|
590
|
+
Additional options:
|
|
591
|
+
|
|
592
|
+
| Option | Type | Default | Constraints and meaning |
|
|
593
|
+
| --- | --- | --- | --- |
|
|
594
|
+
| `detect_files` | string array | `[]` | Entries may not start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
595
|
+
| `detect_extensions` | string array | `[]` | Entries may not start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
596
|
+
| `detect_folders` | string array | `[]` | Entries may not start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
597
|
+
| `only_with_files` | boolean | `false` | Requires a matching direct project detector before showing a non-default Docker context. |
|
|
598
|
+
|
|
599
|
+
### `kubernetes`
|
|
600
|
+
|
|
601
|
+
Active Kubernetes context, namespace, cluster, and user.
|
|
602
|
+
|
|
603
|
+
- Format variables: `$symbol`, `$context`, `$namespace`, `$cluster`, `$user`.
|
|
604
|
+
- Style variables in `format`: `$style`.
|
|
605
|
+
- Default `format`: `"on [$symbol$context( \\($namespace\\))]($style) "`.
|
|
606
|
+
- Default `symbol`: `"☸ "`.
|
|
607
|
+
- Default `disabled`: `false`.
|
|
608
|
+
|
|
609
|
+
Accepted style fields:
|
|
610
|
+
|
|
611
|
+
| Field | Default |
|
|
612
|
+
| --- | --- |
|
|
613
|
+
| `style` | `"cyan bold"` |
|
|
614
|
+
|
|
615
|
+
Additional options:
|
|
616
|
+
|
|
617
|
+
| Option | Type | Default | Constraints and meaning |
|
|
618
|
+
| --- | --- | --- | --- |
|
|
619
|
+
| `context_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact Kubernetes context-name to display-label replacements. |
|
|
620
|
+
| `namespace_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact Kubernetes namespace-name to display-label replacements. |
|
|
621
|
+
| `cluster_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact Kubernetes cluster-name to display-label replacements. |
|
|
622
|
+
| `user_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact Kubernetes user-name to display-label replacements. |
|
|
623
|
+
| `max_config_files` | integer | `8` | Inclusive range 1 through 32. Maximum number of `KUBECONFIG` files read from left to right. |
|
|
624
|
+
|
|
625
|
+
### `terraform`
|
|
626
|
+
|
|
627
|
+
Active Terraform workspace and version.
|
|
628
|
+
|
|
629
|
+
- Format variables: `$symbol`, `$workspace`, `$version`.
|
|
630
|
+
- Style variables in `format`: `$style`.
|
|
631
|
+
- Default `format`: `"via [$symbol$workspace]($style) "`.
|
|
632
|
+
- Default `symbol`: `"💠 "`.
|
|
633
|
+
- Default `disabled`: `false`.
|
|
634
|
+
|
|
635
|
+
Accepted style fields:
|
|
636
|
+
|
|
637
|
+
| Field | Default |
|
|
638
|
+
| --- | --- |
|
|
639
|
+
| `style` | `"bold 105"` |
|
|
640
|
+
|
|
641
|
+
Additional options:
|
|
642
|
+
|
|
643
|
+
| Option | Type | Default | Constraints and meaning |
|
|
644
|
+
| --- | --- | --- | --- |
|
|
645
|
+
| `detect_files` | string array | `[]` | Entries may not start with `!`. Direct current-directory file-name detectors; a non-empty array replaces that module's built-in file defaults. |
|
|
646
|
+
| `detect_extensions` | string array | `[]` | Entries may not start with `!`. Direct current-directory extension detectors without a leading dot; a non-empty array replaces built-in extension defaults. |
|
|
647
|
+
| `detect_folders` | string array | `[]` | Entries may not start with `!`. Direct current-directory folder-name detectors; a non-empty array replaces built-in folder defaults. |
|
|
648
|
+
| `version_format` | string | `"v$raw"` | May be empty. Version template in which `$raw` is replaced with the collected version. |
|
|
649
|
+
|
|
650
|
+
### `aws`
|
|
651
|
+
|
|
652
|
+
Active AWS profile and region.
|
|
653
|
+
|
|
654
|
+
- Format variables: `$symbol`, `$profile`, `$region`.
|
|
655
|
+
- Style variables in `format`: `$style`.
|
|
656
|
+
- Default `format`: `"on [$symbol($profile )(\\($region\\) )]($style)"`.
|
|
657
|
+
- Default `symbol`: `"☁️ "`.
|
|
658
|
+
- Default `disabled`: `false`.
|
|
659
|
+
|
|
660
|
+
Accepted style fields:
|
|
661
|
+
|
|
662
|
+
| Field | Default |
|
|
663
|
+
| --- | --- |
|
|
664
|
+
| `style` | `"bold yellow"` |
|
|
665
|
+
|
|
666
|
+
Additional options:
|
|
667
|
+
|
|
668
|
+
| Option | Type | Default | Constraints and meaning |
|
|
669
|
+
| --- | --- | --- | --- |
|
|
670
|
+
| `profile_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact AWS profile-name to display-label replacements. |
|
|
671
|
+
| `region_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact region-name to display-label replacements. |
|
|
672
|
+
|
|
673
|
+
### `gcloud`
|
|
674
|
+
|
|
675
|
+
Active Google Cloud project, account, and region.
|
|
676
|
+
|
|
677
|
+
- Format variables: `$symbol`, `$active`, `$account`, `$domain`, `$project`, `$region`.
|
|
678
|
+
- Style variables in `format`: `$style`.
|
|
679
|
+
- Default `format`: `"on [$symbol$project]($style) "`.
|
|
680
|
+
- Default `symbol`: `"☁️ "`.
|
|
681
|
+
- Default `disabled`: `false`.
|
|
682
|
+
|
|
683
|
+
Accepted style fields:
|
|
684
|
+
|
|
685
|
+
| Field | Default |
|
|
686
|
+
| --- | --- |
|
|
687
|
+
| `style` | `"bold blue"` |
|
|
688
|
+
|
|
689
|
+
Additional options:
|
|
690
|
+
|
|
691
|
+
| Option | Type | Default | Constraints and meaning |
|
|
692
|
+
| --- | --- | --- | --- |
|
|
693
|
+
| `project_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact project-name to display-label replacements. |
|
|
694
|
+
| `region_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact region-name to display-label replacements. |
|
|
695
|
+
|
|
696
|
+
### `azure`
|
|
697
|
+
|
|
698
|
+
Active Azure subscription and optional username.
|
|
699
|
+
|
|
700
|
+
- Format variables: `$symbol`, `$subscription`, `$username`.
|
|
701
|
+
- Style variables in `format`: `$style`.
|
|
702
|
+
- Default `format`: `"on [$symbol$subscription]($style) "`.
|
|
703
|
+
- Default `symbol`: `" "`.
|
|
704
|
+
- Default `disabled`: `false`.
|
|
705
|
+
|
|
706
|
+
Accepted style fields:
|
|
707
|
+
|
|
708
|
+
| Field | Default |
|
|
709
|
+
| --- | --- |
|
|
710
|
+
| `style` | `"blue bold"` |
|
|
711
|
+
|
|
712
|
+
Additional options:
|
|
713
|
+
|
|
714
|
+
| Option | Type | Default | Constraints and meaning |
|
|
715
|
+
| --- | --- | --- | --- |
|
|
716
|
+
| `subscription_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact Azure subscription-name to display-label replacements. |
|
|
717
|
+
| `show_username` | boolean | `false` | Allows the Azure module to expose the selected subscription's local username field. |
|
|
718
|
+
|
|
719
|
+
### `openstack`
|
|
720
|
+
|
|
721
|
+
Active OpenStack cloud and project.
|
|
722
|
+
|
|
723
|
+
- Format variables: `$symbol`, `$cloud`, `$project`.
|
|
724
|
+
- Style variables in `format`: `$style`.
|
|
725
|
+
- Default `format`: `"on [$symbol$cloud( \\($project\\))]($style) "`.
|
|
726
|
+
- Default `symbol`: `"☁️ "`.
|
|
727
|
+
- Default `disabled`: `false`.
|
|
728
|
+
|
|
729
|
+
Accepted style fields:
|
|
730
|
+
|
|
731
|
+
| Field | Default |
|
|
732
|
+
| --- | --- |
|
|
733
|
+
| `style` | `"bold yellow"` |
|
|
734
|
+
|
|
735
|
+
Additional options:
|
|
736
|
+
|
|
737
|
+
| Option | Type | Default | Constraints and meaning |
|
|
738
|
+
| --- | --- | --- | --- |
|
|
739
|
+
| `cloud_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact OpenStack cloud-name to display-label replacements. |
|
|
740
|
+
| `project_aliases` | string-to-string table | `{}` | Keys and values are strings. Exact project-name to display-label replacements. |
|
|
741
|
+
|
|
742
|
+
### `os`
|
|
743
|
+
|
|
744
|
+
Current operating system identity.
|
|
745
|
+
|
|
746
|
+
- Format variables: `$symbol`, `$type`, `$name`, `$version`, `$edition`, `$codename`.
|
|
747
|
+
- Style variables in `format`: `$style`.
|
|
748
|
+
- Default `format`: `"[$symbol($name )]($style)"`.
|
|
749
|
+
- Default `symbol`: `""`.
|
|
750
|
+
- Default `disabled`: `true`.
|
|
751
|
+
|
|
752
|
+
Accepted style fields:
|
|
753
|
+
|
|
754
|
+
| Field | Default |
|
|
755
|
+
| --- | --- |
|
|
756
|
+
| `style` | `"bold white"` |
|
|
757
|
+
|
|
758
|
+
Additional options:
|
|
759
|
+
|
|
760
|
+
| Option | Type | Default | Constraints and meaning |
|
|
761
|
+
| --- | --- | --- | --- |
|
|
762
|
+
| `symbols` | string-to-string table | `{"linux":"🐧 ","macos":"🍎 ","windows":" ","wsl":" "}` | Keys and values are strings. Exact OS type to symbol replacements for `linux`, `macos`, `windows`, `wsl`, or another reported platform type. |
|
|
763
|
+
|
|
764
|
+
### `container`
|
|
765
|
+
|
|
766
|
+
Current container or remote development environment.
|
|
767
|
+
|
|
768
|
+
- Format variables: `$symbol`, `$name`, `$type`.
|
|
769
|
+
- Style variables in `format`: `$style`.
|
|
770
|
+
- Default `format`: `"[$symbol$name]($style) "`.
|
|
771
|
+
- Default `symbol`: `"⬢ "`.
|
|
772
|
+
- Default `disabled`: `false`.
|
|
773
|
+
|
|
774
|
+
Accepted style fields:
|
|
775
|
+
|
|
776
|
+
| Field | Default |
|
|
777
|
+
| --- | --- |
|
|
778
|
+
| `style` | `"bold red dimmed"` |
|
|
779
|
+
|
|
780
|
+
### `hostname`
|
|
781
|
+
|
|
782
|
+
Current host name, normally shown for remote sessions.
|
|
783
|
+
|
|
784
|
+
- Format variables: `$symbol`, `$hostname`, `$ssh_symbol`.
|
|
785
|
+
- Style variables in `format`: `$style`.
|
|
786
|
+
- Default `format`: `"[$ssh_symbol$hostname]($style) in "`.
|
|
787
|
+
- Default `symbol`: `""`.
|
|
788
|
+
- Default `disabled`: `false`.
|
|
789
|
+
|
|
790
|
+
Accepted style fields:
|
|
791
|
+
|
|
792
|
+
| Field | Default |
|
|
793
|
+
| --- | --- |
|
|
794
|
+
| `style` | `"bold dimmed green"` |
|
|
795
|
+
|
|
796
|
+
Additional options:
|
|
797
|
+
|
|
798
|
+
| Option | Type | Default | Constraints and meaning |
|
|
799
|
+
| --- | --- | --- | --- |
|
|
800
|
+
| `ssh_only` | boolean | `true` | Shows hostname only when `SSH_CONNECTION` or `SSH_TTY` is present. |
|
|
801
|
+
| `trim_at` | string | `"."` | May be empty. Removes the first occurrence of this delimiter and everything after it before hostname alias lookup; empty disables trimming. |
|
|
802
|
+
| `aliases` | string-to-string table | `{}` | Keys and values are strings. Exact collected value to display-label replacements for this module. |
|
|
803
|
+
|
|
804
|
+
### `username`
|
|
805
|
+
|
|
806
|
+
Current user identity when configured to display.
|
|
807
|
+
|
|
808
|
+
- Format variables: `$symbol`, `$user`.
|
|
809
|
+
- Style variables in `format`: `$style`.
|
|
810
|
+
- Default `format`: `"[$user]($style) in "`.
|
|
811
|
+
- Default `symbol`: `""`.
|
|
812
|
+
- Default `disabled`: `false`.
|
|
813
|
+
|
|
814
|
+
Accepted style fields:
|
|
815
|
+
|
|
816
|
+
| Field | Default |
|
|
817
|
+
| --- | --- |
|
|
818
|
+
| `style_user` | `"yellow bold"` |
|
|
819
|
+
| `style_root` | `"red bold"` |
|
|
820
|
+
|
|
821
|
+
Additional options:
|
|
822
|
+
|
|
823
|
+
| Option | Type | Default | Constraints and meaning |
|
|
824
|
+
| --- | --- | --- | --- |
|
|
825
|
+
| `show_always` | boolean | `false` | Shows username outside SSH, privileged, login-mismatch, and configured environment-variable conditions. |
|
|
826
|
+
| `aliases` | string-to-string table | `{}` | Keys and values are strings. Exact collected value to display-label replacements for this module. |
|
|
827
|
+
| `detect_env_vars` | string array | `[]` | Entries may not start with `!`. Environment-variable names whose presence makes username visible; negated names are rejected. |
|
|
828
|
+
|
|
829
|
+
### `activity`
|
|
830
|
+
|
|
831
|
+
Current Pi activity, extension UI wait, or most recently completed tool.
|
|
832
|
+
|
|
833
|
+
- Format variables: `$symbol`, `$state`, `$tool`, `$count`, `$kind`, `$title`, `$text`.
|
|
834
|
+
- Style variables in `format`: `$style`.
|
|
835
|
+
- Default `format`: `"[ $text ]($style)"`.
|
|
836
|
+
- Default `symbol`: `"⚙️"`.
|
|
837
|
+
- Default `disabled`: `false`.
|
|
838
|
+
|
|
839
|
+
Accepted style fields:
|
|
840
|
+
|
|
841
|
+
| Field | Default |
|
|
842
|
+
| --- | --- |
|
|
843
|
+
| `style` | `"bold yellow"` |
|
|
844
|
+
|
|
845
|
+
### `context`
|
|
846
|
+
|
|
847
|
+
Current model context-window usage.
|
|
848
|
+
|
|
849
|
+
- Format variables: `$symbol`, `$percentage`, `$tokens`, `$window`.
|
|
850
|
+
- Style variables in `format`: `$style`.
|
|
851
|
+
- Default `format`: `"[$symbol ctx $percentage ]($style)"`.
|
|
852
|
+
- Default `symbol`: `"🪟"`.
|
|
853
|
+
- Default `disabled`: `false`.
|
|
854
|
+
|
|
855
|
+
Accepted state-selected style field:
|
|
856
|
+
|
|
857
|
+
- `display`: array of tables with finite numeric `threshold`, valid string `style`, and boolean `hidden`.
|
|
858
|
+
- Default `display`: `[{"threshold":0,"style":"bold green","hidden":true},{"threshold":30,"style":"bold green","hidden":false},{"threshold":60,"style":"bold yellow","hidden":false},{"threshold":80,"style":"bold red","hidden":false}]`.
|
|
859
|
+
|
|
860
|
+
### `tokens`
|
|
861
|
+
|
|
862
|
+
Session input and output token totals.
|
|
863
|
+
|
|
864
|
+
- Format variables: `$symbol`, `$input`, `$output`, `$total`.
|
|
865
|
+
- Style variables in `format`: `$style`.
|
|
866
|
+
- Default `format`: `"[$symbol ↑$input ↓$output ]($style)"`.
|
|
867
|
+
- Default `symbol`: `"🔢"`.
|
|
868
|
+
- Default `disabled`: `false`.
|
|
869
|
+
|
|
870
|
+
Accepted style fields:
|
|
871
|
+
|
|
872
|
+
| Field | Default |
|
|
873
|
+
| --- | --- |
|
|
874
|
+
| `style` | `"bold cyan"` |
|
|
875
|
+
|
|
876
|
+
### `cache`
|
|
877
|
+
|
|
878
|
+
Prompt-cache usage and latest cache hit rate.
|
|
879
|
+
|
|
880
|
+
- Format variables: `$symbol`, `$rate`, `$read`, `$write`.
|
|
881
|
+
- Style variables in `format`: `$style`.
|
|
882
|
+
- Default `format`: `"[$symbol (CH$rate )]($style)"`.
|
|
883
|
+
- Default `symbol`: `"📦"`.
|
|
884
|
+
- Default `disabled`: `true`.
|
|
885
|
+
|
|
886
|
+
Accepted style fields:
|
|
887
|
+
|
|
888
|
+
| Field | Default |
|
|
889
|
+
| --- | --- |
|
|
890
|
+
| `style` | `"bold green"` |
|
|
891
|
+
|
|
892
|
+
### `cost`
|
|
893
|
+
|
|
894
|
+
Reported estimated session cost or subscription state.
|
|
895
|
+
|
|
896
|
+
- Format variables: `$symbol`, `$cost`, `$subscription`.
|
|
897
|
+
- Style variables in `format`: `$style`.
|
|
898
|
+
- Default `format`: `"[ $symbol \\$$cost( $subscription) ]($style)"`.
|
|
899
|
+
- Default `symbol`: `"💸"`.
|
|
900
|
+
- Default `disabled`: `false`.
|
|
901
|
+
|
|
902
|
+
Accepted state-selected style field:
|
|
903
|
+
|
|
904
|
+
- `display`: array of tables with finite numeric `threshold`, valid string `style`, and boolean `hidden`.
|
|
905
|
+
- Default `display`: `[{"threshold":0,"style":"bold green","hidden":true},{"threshold":1,"style":"bold yellow","hidden":false},{"threshold":5,"style":"bold red","hidden":false}]`.
|
|
906
|
+
|
|
907
|
+
### `time`
|
|
908
|
+
|
|
909
|
+
Current local time.
|
|
910
|
+
|
|
911
|
+
- Format variables: `$symbol`, `$time`.
|
|
912
|
+
- Style variables in `format`: `$style`.
|
|
913
|
+
- Default `format`: `"[$symbol $time ]($style)"`.
|
|
914
|
+
- Default `symbol`: `"🕒"`.
|
|
915
|
+
- Default `disabled`: `false`.
|
|
916
|
+
|
|
917
|
+
Accepted style fields:
|
|
918
|
+
|
|
919
|
+
| Field | Default |
|
|
920
|
+
| --- | --- |
|
|
921
|
+
| `style` | `"bold yellow"` |
|
|
922
|
+
|
|
923
|
+
### `turn`
|
|
924
|
+
|
|
925
|
+
Current user-turn count.
|
|
926
|
+
|
|
927
|
+
- Format variables: `$symbol`, `$count`.
|
|
928
|
+
- Style variables in `format`: `$style`.
|
|
929
|
+
- Default `format`: `"[$symbol #$count ]($style)"`.
|
|
930
|
+
- Default `symbol`: `"🔁"`.
|
|
931
|
+
- Default `disabled`: `false`.
|
|
932
|
+
|
|
933
|
+
Accepted style fields:
|
|
934
|
+
|
|
935
|
+
| Field | Default |
|
|
936
|
+
| --- | --- |
|
|
937
|
+
| `style` | `"bold purple"` |
|
|
938
|
+
|
|
939
|
+
### `fill`
|
|
940
|
+
|
|
941
|
+
Flexible spacing that aligns content within the footer width.
|
|
942
|
+
|
|
943
|
+
- Format variables: `$symbol`.
|
|
944
|
+
- Style variables in `format`: `$style`.
|
|
945
|
+
- Default `format`: `"[$symbol]($style)"`.
|
|
946
|
+
- Default `symbol`: `" "`.
|
|
947
|
+
- Default `disabled`: `false`.
|
|
948
|
+
- Layout role: `"fill"`.
|
|
949
|
+
|
|
950
|
+
Accepted style fields:
|
|
951
|
+
|
|
952
|
+
| Field | Default |
|
|
953
|
+
| --- | --- |
|
|
954
|
+
| `style` | `"bold black"` |
|
|
955
|
+
|
|
956
|
+
### `extension_status`
|
|
957
|
+
|
|
958
|
+
Statuses published through Pi's extension-neutral status map.
|
|
959
|
+
|
|
960
|
+
- Format variables: `$symbol`, `$statuses`, `$count`.
|
|
961
|
+
- Style variables in `format`: `$style`.
|
|
962
|
+
- Default `format`: `"[$statuses]($style)"`.
|
|
963
|
+
- Default `symbol`: `""`.
|
|
964
|
+
- Default `disabled`: `false`.
|
|
965
|
+
|
|
966
|
+
Accepted style fields:
|
|
967
|
+
|
|
968
|
+
| Field | Default |
|
|
969
|
+
| --- | --- |
|
|
970
|
+
| `style` | `"dimmed white"` |
|
|
971
|
+
|
|
972
|
+
Additional options:
|
|
973
|
+
|
|
974
|
+
| Option | Type | Default | Constraints and meaning |
|
|
975
|
+
| --- | --- | --- | --- |
|
|
976
|
+
| `separator` | string | `" • "` | May be empty. Text inserted between rendered extension statuses. |
|
|
977
|
+
| `max_statuses` | integer | `5` | Inclusive range 0 through 100. Maximum number of extension statuses rendered; zero hides all status values. |
|
|
978
|
+
| `icons` | string-to-string table | `{}` | Keys and values are strings. Exact status-key and explicit `namespace:*` icon mappings, plus optional `fallback`. |
|