Open chipzoller opened 7 months ago
adding a line to a file
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 🤞 It's not high priority but would be good to have if we can.
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