Llewellyn
/
starship
mirror of https://github.com/Llewellynvdm/starship.git
1
0
Fork 0
Code Issues Releases Activity

docs(cmd_duration): Document cmd_duration notifications (#1831) 

* docs: add options for cmd_duration notifications

Added in #1019

* Update docs/config/README.md

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
This commit is contained in:
juno suárez 2020-11-04 09:53:51 -08:00 committed by GitHub
parent 368945f5db
commit 597fd40812
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/config/README.md
View File

@ -496,6 +496,15 @@ running `eval $(starship init $0)`, and then proceed as normal.
| `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications`| `false` | Show desktop notifications when command completes. |
| `min_time_to_notify`| `45_000` | Shortest duration for notification (in milliseconds). |
::: tip
Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship
supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`.
:::
### Variables