dnscontrol/documentation/colors.md
Costas Drogos 012c9441cb
New flag: --no-colors (disables colored output) (#2507)
Co-authored-by: Jeffrey Cafferata <jeffrey@jcid.nl>
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
2023-08-18 09:19:18 -04:00

988 B

Colors support

DNSControl is using colors on both its console and notification outputs, to denote changes, such as during preview or push events.

This is on by default in all interactive prompts supporting colors. See below on how to bypass it.

Disable colors

There are cases that we might need to disable colored output, such as in certain CI environments or particular notification mechanisms that don't support ANSI color codes.

In order to do so, a global --no-colors command option is provided, which when set --no-colors=true, will disable colors globally.

(Force) Enable colors

If color support is not correctly detected, providing --no-colors=false would force-enable coloring, bypassing modules TTY detection.

Force colors in CI environments

Some CI environments, while supporting colors, fail autodetection, such as GHA. In that case, colors can be forcibly enabled via --no-colors=false or by setting a CI env variable to true (if not autoset).