search

carvel-dev / kapp

kapp is a simple deployment tool focused on the concept of "Kubernetes application" — a set of resources with the same label
https://carvel.dev/kapp
Apache License 2.0
899 stars 108 forks source link

Document FORCE_COLOR=1 in kapp --help #632

Open gberche-orange opened 1 year ago

gberche-orange commented 1 year ago

Describe the problem/challenge you have

In order to include a shortcut for kapp in k9s (see https://github.com/derailed/k9s/pull/1830), I need to pipe kapp output to the less command.

Unless the export FORCE_COLOR=1 prereq, the kapp inspect | less -R fails to display colors. Same with --color or --tty flags

After searching a while, finally found the flag in https://kubernetes.slack.com/archives/CH8KCCKA5/p1600180101408100?thread_ts=1600180052.407500&cid=CH8KCCKA5

Describe the solution you'd like

kapp --help displays :

Environment Variables:
 - FORCE_COLOR: set to 1 to force colors to the printed. Useful in 'kapp ..| less -R'

Anything else you would like to add: [Additional information that will assist in solving the issue.]

Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible" 👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

cppforlife commented 1 year ago

related partial work: https://github.com/vmware-tanzu/carvel/pull/581

praveenrewar commented 1 year ago

Hey @gberche-orange! Thank you for creating this issue. The environment variable addition to kapp help section sounds good to me. Would you like to work on a PR for this?