Skip to content

Commit

Permalink
Update README.md plugin format (derailed#2788)
Browse files Browse the repository at this point in the history
* Update README.md plugin for Shortcut and OverwriteOutput

See https://github.com/derailed/k9s/blob/a07243dbb09ed8b7727e3229ac0314ed2e475d37/change_logs/release_0.8.0.md#L51 for supported

* Update README.md with plugin dangerous field

Relates to derailed#2604 introduced in derailed#2637
  • Loading branch information
gberche-orange authored and uozalp committed Sep 2, 2024
1 parent 85aa920 commit 0a0ed16
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -647,15 +647,16 @@ 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-z], Shift-[A-Z], Ctrl-[A-Z].
* 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
* 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)
* Dangerous boolean option enables disabling the plugin when read-only mode is set. See [#2604](https://github.com/derailed/k9s/issues/2604)

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 @@ -687,7 +688,9 @@ plugins:
fred:
shortCut: Ctrl-L
override: false
overwriteOutput: false
confirm: false
dangerous: false
description: Pod logs
scopes:
- pods
Expand Down

0 comments on commit 0a0ed16

Please sign in to comment.