smallstep / cli-utils Goto Github PK

Since f41a85a, Caddy users on Windows have had their terminals break after running any caddy CLI command, because the console mode never gets reset.

See caddyserver/caddy#4251 for details.

I suggest that the code in ui/ui_windows.go is changed to only get invoked at the CLI entrypoints for smallstep instead of inside of an init() so that it doesn't clobber terminal state. Ideally, for smallstep users, the terminal state should get reset before the commands exit as well.

This could be done with a ui_other.go which is a no-op on other platforms than Windows, and both have setupTerminalState() and cleanupTerminalState() functions (or whatever name best fits) which get called only for Smallstep's CLI.

Caddy uses cli-utils indirectly through these dependencies:

$ go mod why go.step.sm/cli-utils/ui
# go.step.sm/cli-utils/ui
github.com/caddyserver/caddy/v2/modules/caddypki
github.com/smallstep/certificates/authority
github.com/smallstep/certificates/kms
github.com/smallstep/certificates/kms/softkms
go.step.sm/cli-utils/ui

Credit to https://github.com/egonelbre for spotting the cause of the issue, and https://github.com/Mohammed90 for exploring a workaround.

I wonder if there is any particular reason to build with github.com/samfoo/ansi, which is a (less maintained) fork of github.com/mgutz/ansi?

I noticed recentrly when packaging this library for debian, which already has github.com/mgutz/ansi in its archives. I added a patch for cli-utils to use that instead which builds/works fine.

Could do PR if you agree