-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature] chainsaw explain
command
#1022
Labels
enhancement
New feature or request
Comments
chipzoller
changed the title
[Feature]
[Feature] Mar 3, 2024
chainsaw explain
chainsaw explain
command
This sounds like a reasonable effort :) |
If it's too difficult for you I understand 😉 |
Let's see if someone wants to give it a try 🤞 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem Statement
Chainsaw is growing more complex and capable with more resources as well as more complexity to each resource. It's becoming more difficult to remember the structure of each field especially as more are being added in this early phase of growth. Flipping over to either other examples or the website isn't a great experience as these things can be incomplete and involve switching between workspaces.
Solution Description
Add an
explain
command just likekubectl explain
which allows users to interactively (and recursively) describe and explain API resources.chainsaw explain test.spec
: explain theTest
resource under thespec
struct. All fields have complete descriptions.chainsaw explain test.spec --recursive
: Similar to the above but with a recursive tree structure for all fields underneath.See an example of this for
kubectl
:Alternatives
JSON schemas are ok but they're clunky and, require either adding a CRD to a cluster or adding a line to a file, and are IDE specific.
Additional Context
Slack discussion
No response
Research
The text was updated successfully, but these errors were encountered: