Skip to content

Commit e8d3594

Browse files
1 parent 350439b commit e8d3594

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -646,15 +646,15 @@ K9s allows you to extend your command line and tooling by defining your very own
646646

647647
A plugin is defined as follows:
648648

649-
* Shortcut option represents the key combination a user would type to activate the plugin
649+
* Shortcut option represents the key combination a user would type to activate the plugin. Valid values are [a-z], Shift-[A-Z], Ctrl-[A-Z].
650650
* Override option make that the default action related to the shortcut will be overrided by the plugin
651651
* Confirm option (when enabled) lets you see the command that is going to be executed and gives you an option to confirm or prevent execution
652652
* Description will be printed next to the shortcut in the k9s menu
653653
* Scopes defines a collection of resources names/short-names for the views associated with the plugin. You can specify `all` to provide this shortcut for all views.
654-
* Command represents ad-hoc commands the plugin runs upon activation
654+
* Command represents ad-hoc commands the plugin runs upon activation. Must be on your $PATH
655655
* Background specifies whether or not the command runs in the background
656656
* Args specifies the various arguments that should apply to the command above
657-
* OverwriteOutput options allows plugin developers to provide custom messages on plugin execution
657+
* OverwriteOutput boolean option allows plugin developers to provide custom messages on plugin stdout execution. See example in [#2644](https://github.com/derailed/k9s/pull/2644)
658658

659659
K9s does provide additional environment variables for you to customize your plugins arguments. Currently, the available environment variables are as follows:
660660

@@ -686,6 +686,7 @@ plugins:
686686
fred:
687687
shortCut: Ctrl-L
688688
override: false
689+
overwriteOutput: false
689690
confirm: false
690691
description: Pod logs
691692
scopes:

0 commit comments

Comments
 (0)