oh-my-posh/website/docs/segments/executiontime.mdx

73 lines
2.8 KiB
Plaintext
Raw Normal View History

2020-12-06 13:03:40 -08:00
---
id: executiontime
title: Execution Time
sidebar_label: Execution Time
---
## What
Displays the execution time of the previously executed command.
2020-12-12 03:53:53 -08:00
To use this, use the PowerShell module, or confirm that you are passing an `execution-time` argument containing the
elapsed milliseconds to the oh-my-posh executable.
2021-06-03 11:01:46 -07:00
The installation guide shows how to include this argument for PowerShell and Zsh.
2020-12-06 13:03:40 -08:00
## Sample Configuration
2023-03-31 11:55:36 -07:00
import Config from '@site/src/components/Config.js';
<Config data={{
2020-12-06 13:03:40 -08:00
"type": "executiontime",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#ffffff",
"background": "#8800dd",
"template": " <#fefefe>\ufbab</> {{ .FormattedMs }} ",
2020-12-06 13:03:40 -08:00
"properties": {
"threshold": 500,
2022-03-27 01:12:47 -07:00
"style": "austin"
2020-12-06 13:03:40 -08:00
}
2023-03-31 11:55:36 -07:00
}}/>
2020-12-06 13:03:40 -08:00
## Properties
| Name | Type | Description |
| ---------------- | --------- | ----------------------------------------------------------------------------------- |
| `always_enabled` | `boolean` | always show the duration - defaults to `false` |
| `threshold` | `number` | minimum duration (milliseconds) required to enable this segment - defaults to `500` |
| `style` | `enum` | one of the available format options - defaults to `austin` |
2020-12-10 07:02:45 -08:00
### Style
2020-12-10 07:02:45 -08:00
Style specifies the format in which the time will be displayed. The table below shows some example times in each option.
| format | 0.001s | 2.1s | 3m2.1s | 4h3m2.1s |
| ------------- | -------------- | -------------- | -------------- | ---------------- |
| `austin` | `1ms` | `2.1s` | `3m 2.1s` | `4h 3m 2.1s` |
| `roundrock` | `1ms` | `2s 100ms` | `3m 2s 100ms` | `4h 3m 2s 100ms` |
| `dallas` | `0.001` | `2.1` | `3:2.1` | `4:3:2.1` |
| `galveston` | `00:00:00` | `00:00:02` | `00:03:02` | `04:03:02` |
| `galvestonms` | `00:00:00:001` | `00:00:02:100` | `00:03:02:100` | `04:03:02:100` |
| `houston` | `00:00:00.001` | `00:00:02.1` | `00:03:02.1` | `04:03:02.1` |
| `amarillo` | `0.001s` | `2.1s` | `182.1s` | `14,582.1s` |
| `round` | `1ms` | `2s` | `3m 2s` | `4h 3m` |
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
```template
2022-02-01 03:10:46 -08:00
{{ .FormattedMs }}
```
:::
### Properties
| Name | Type | Description |
| -------------- | -------- | ---------------------------------------------- |
| `.Ms` | `number` | the execution time in milliseconds |
| `.FormattedMs` | `string` | the formatted value based on the `style` above |
2022-01-22 10:46:56 -08:00
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates