From 463c97b17e8b69a9bb3430b943f3164b1b09c567 Mon Sep 17 00:00:00 2001 From: Kisaragi Hiu Date: Wed, 10 Apr 2024 03:14:17 +0900 Subject: [PATCH] usage: clarify api_key_vault_cmd "shell command" implies it goes through a shell, whereas it is in fact only split on spaces as a command: https://github.com/wakatime/wakatime-cli/blob/1fd560a/cmd/params/params.go#L707 So, it is a space-separated list of an executable and its arguments. --- USAGE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/USAGE.md b/USAGE.md index c4e4fa85..7df178f4 100644 --- a/USAGE.md +++ b/USAGE.md @@ -37,7 +37,7 @@ Here's an example `$WAKATIME_HOME/.wakatime.cfg` config file with all available [settings] debug = false api_key = your-api-key -api_key_vault_cmd = any shell command to get your api key from vault +api_key_vault_cmd = command arg arg ... (space-separated, no shell syntax) api_url = https://api.wakatime.com/api/v1 hide_file_names = false hide_project_names = false @@ -89,7 +89,7 @@ some/submodule/name = new project name | --- | --- | --- | --- | | debug | Turns on debug messages in log file. | _bool_ | `false` | | api_key | Your wakatime api key. | _string_ | | -| api_key_vault_cmd | Any shell command to get your api key from vault. | _string_ | | +| api_key_vault_cmd | A command to get your api key, perhaps from some sort of secure vault. Actually a space-separated list of an executable and its arguments. Executables in PATH can be referred to by their basenames. Shell syntax not supported. | _string_ | | | api_url | The WakaTime API base url. | _string_ | | | hide_file_names | Obfuscate filenames. Will not send file names to api. | _bool_;_list_ | `false` | | hide_project_names | Obfuscate project names. When a project folder is detected instead of using the folder name as the project, a `.wakatime-project file` is created with a random project name. | _bool_;_list_ | `false` |