Skip to content

Commit

Permalink
Update README.md plugin for Scopes and OverwriteOutput
Browse files Browse the repository at this point in the history
  • Loading branch information
gberche-orange authored Jul 12, 2024
1 parent 80c0389 commit 4b91550
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -646,15 +646,15 @@ K9s allows you to extend your command line and tooling by defining your very own

A plugin is defined as follows:

* Shortcut option represents the key combination a user would type to activate the plugin
* Shortcut option represents the key combination a user would type to activate the plugin. Valid values are [a-z0-9], Shift-[A-Z0-9], Ctrl-[A-Z0-9] or Alt-[A-Z0-9]
* Override option make that the default action related to the shortcut will be overrided by the plugin
* 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
* Description will be printed next to the shortcut in the k9s menu
* 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.
* Command represents ad-hoc commands the plugin runs upon activation
* Command represents ad-hoc commands the plugin runs upon activation. Must be on your $PATH
* Background specifies whether or not the command runs in the background
* Args specifies the various arguments that should apply to the command above
* OverwriteOutput options allows plugin developers to provide custom messages on plugin execution
* 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)

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

Expand Down Expand Up @@ -686,9 +686,10 @@ plugins:
fred:
shortCut: Ctrl-L
override: false
overwriteOutput: false
confirm: false
description: Pod logs
scopes: # set to 'all' to match all resources
scopes:
- pods
command: kubectl
background: false
Expand Down

0 comments on commit 4b91550

Please sign in to comment.