aklin / kubectl-prettifier-script

A kubectl wrapper applying syntax highlighting to kubectl output.

kubectl-prettifier-script

A kubectl wrapper applying syntax highlighting to kubectl output.

Installation

1. Install highlight.
2. Create a file named kubectl-prettify somewhere on your $PATH.
3. Copy the script contents into the new file.
4. Make the new file executable: chmod +x /usr/bin/kubectl-prettify.
5. Verify correct installation with kubectl plugins list.
6. (Optional) Alias: alias kubectl="kubectl prettify".

Supported Systems

System	Support
Linux	✓
OSX	✗
Windows	✗

kubectl-prettifier-script's Issues

As a developer, I want to compile and publish packages for major distributions.

User Story

As soon as I push my changes, I want my code to be

1. Packaged
2. Versioned
3. Published

Reimplement as kubectl plugin

https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/

...

As a user I want command output to be prettified for easier parsing.

User Story

Many command outputs is text-dense and not hard to skim quickly. As a user I want to prettify the output with syntax highlighting.

This is different from #1 because it focuses on command output, not highlighting of yaml or json output.

Candidate Commands

• get nodes
• version
• describe

As a user, I want my logs to be saved automatically whenever I view them

User Story

When I run kubectl logs resource I want those log to be saved automatically, using a descriptive naming system.

Naming

Each output file name must be

• Unique to cluster, namespace, and resource.
• Timestamped.
  ** Possibly parse the --since parameter if present and adjust the timestamp accordingly.

Spaces between parameters are ignored

Output of -o yaml parameteris not highlighted.

As a user, I want to see kubectl use syntax highlighting when I get json/yaml output.

User Story

Output from commands with -oyaml or similar flags comes as plain text, with no syntax highlighting. I would like my output to be properly highlighted.

As a user I want to control whether my output gets post-processed

User Story

As a user I want to configure if and how the kubectl output gets post-processed before finally sent to stdout.