derailed / k9s

🐶 Kubernetes CLI To Manage Your Clusters In Style!
https://k9scli.io
Apache License 2.0
26.89k stars 1.69k forks source link

Missing xr command for :xray #1531

Open Nitrodist opened 2 years ago

Nitrodist commented 2 years ago

Describe the bug I don't know how to use the :xray command. I've installed k9s and I use it on mac. I don't know what the backing command for 'xr' is and googling 'k9s xr' or 'k9s xray' etc. did not yield much.

I'd like the documentation updated to clarify what I should install specifically? I.e. using homebrew to install a package.

To Reproduce Steps to reproduce the behaviour:

  1. Run :xray
  2. See cow
  3. Google for 'xr xray k9s' and never come across anything explaining this error etc.

Expected behaviour

I'd like the documentation updated to clarify what I should install specifically? I.e. using homebrew to install a package.

In the end, I'd like to get the feature working as demonstrated on the k9scli.io docs site.

Screenshots

Screen Shot 2022-04-20 at 1 48 43 PM

Versions (please complete the following information):

Additional context

I would like to see a doc page for this somewhere.

JefeDavis commented 2 years ago

Hey @Nitrodist! the x-ray command allows you to view resources in a tree style view

The usage is :xray [Resource] for example if you use :xray deployment you would see all of your deployments in a tree style list with their linked services, secrets, config maps, etc. These items also act as shortcuts to go directly to that item. This can be very convenient for getting a "whole picture" view of your resource. I do agree that there isn't a lot of documentation around this feature other than a one line blurb on the readme. I did find a video that may give you a little more info: https://youtu.be/jovHiTobzKQ?t=11m57s

Hope this helps!

Nitrodist commented 2 years ago

I mean, what is the backing command?

JefeDavis commented 2 years ago

As far as I know, there isn't one, this feature is unique to k9s. Its just another way to view your kubernetes resources

JefeDavis commented 2 years ago

Running :xray by itself won't work, you need to add the resource type you want to view aka :xray deployment or :xray dp for short