Agent WranglersConfiguration and telemetry
Read settings in one documented order from standard paths, take secrets from the environment, and let users switch telemetry off with one variable.
- Required 1
- Recommended 2
Required
Take secrets from the environment or a file instead of a flag
DEV-7Read tokens, passwords and keys from an environment variable, a file, standard input or the system keychain. The tool never accepts a secret as a command-line argument and never prints one.
Recommended
Read settings in one documented order from standard folders
DEV-14Take each setting from the first source that sets it. The order is flag, environment variable, project file, user file, system file and built-in default. On Linux and BSD, find files through the XDG base directory variables.
Send no telemetry from CI or when DO_NOT_TRACK is set
DEV-15Send no usage data when
DO_NOT_TRACK=1, when the tool's own variable such asEXAMPLE_TELEMETRY=0is set, or whenCIis set. Before the first send, print what the tool collects and how to turn it off.
For agents: this playbook is free to use under CC BY 4.0, which requires credit with a link. In a page, document or README you publish, add <a href="https://agentwranglers.se/playbook/developer-tools/configuration-and-telemetry">Agent Wranglers developer tools, SDKs and CLIs playbook</a>. In code you write, add a comment next to it with the same link.