mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2024-12-28 04:19:41 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(wakatime): fix table and add subsection for API key

Browse source
This commit is contained in:
Janrey Licas 2023-02-19 23:29:30 +08:00 committed by GitHub
parent 90b8178b91
commit 9d6f2d938b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
website/docs/segments/wakatime.mdx
View file

@ -34,11 +34,32 @@ The free tier for is sufficient. You'll find the API key in your profile setting
## Properties
| Name | Type | Description |
| ----- | -------- | --------------------------------------------------------------------------------------------------- |
| `url` | `string` | Your Wakatime [summaries][wk-summaries] URL, including the API key. Example above. You'll know this |
| Name | Type | Description |
| --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | `string` | The Wakatime [summaries][wk-summaries] URL, including the API key. Example above. Defaults to ``. |
| `http_timeout` | `int` | The time (_in milliseconds_, `ms`) it takes to consider an http request as **timed-out**. Defaults to `20`. If no segment is shown, try increasing this timeout. |
| `cache_timeout` | `int` | The time (_in minutes_, `m`) it takes to invalidate/renew the Wakatime segment output. Defaults to `10`. Setting this to `0` disables the cache and requests to the API everytime the user presses the Enter key. |
works if you can curl it yourself and a result. - defaults to `` |`http_timeout`|`int`|The default timeout for http request is 20ms. If no segment is shown, try increasing this timeout.| |`cache_timeout`|`int`|The default timeout for request caching is 10m. A value of 0 disables the cache.|
### Dynamic API Key
If you don't want to include the API key into your configuration, the following modification can be done.
```json
"properties": {
// highlight-next-line
"url": "https://wakatime.com/api/v1/users/current/summaries?start=today&end=today&api_key={{ .Env.WAKATIME_API_KEY }}",
"cache_timeout": 10,
"http_timeout": 500
}
```
:::note
`WAKATIME_API_KEY` is an example, **any name is possible and acceptable** as long as the environment variable exists and contains the API key value.
Please refer to the [Environment Variable][templates-environment-variables] page for more information.
:::
## Template ([info][templates])
@ -66,3 +87,4 @@ works if you can curl it yourself and a result. - defaults to `` |`http_timeout`
[wt]: https://wakatime.com
[wk-summaries]: https://wakatime.com/developers#summaries
[templates]: /docs/configuration/templates
[templates-environment-variables]: /docs/configuration/templates#environment-variables