From b33b7a811bd939d2c25b705493119ce57784a4ae Mon Sep 17 00:00:00 2001 From: Somsubhra Bairi Date: Thu, 17 Oct 2024 11:40:57 +0530 Subject: [PATCH 1/3] #51 Added docs for completion command in score-k8s Signed-off-by: Somsubhra Bairi --- .../en/docs/score implementation/score-k8s.md | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/content/en/docs/score implementation/score-k8s.md b/content/en/docs/score implementation/score-k8s.md index 60472fc4..beaf8599 100644 --- a/content/en/docs/score implementation/score-k8s.md +++ b/content/en/docs/score implementation/score-k8s.md @@ -151,6 +151,57 @@ Displays help information for `generate`, providing a short description of the c score-k8s generate --help ``` +## `completion` + +Generate the autocompletion script for `score-k8s` for the specified shell. See each sub-command's help for details on how to use the generated script. + +#### Sub-Commands + +The `completion` commands supports the following sub-commands. + +#### `bash` + +Generate completions for bash + +```bash +score-k8s completion bash +``` + +#### `zsh` + +Generate completions for zsh + +```bash +score-k8s completion zsh +``` + +#### `fish` + +Generate completions for fish + +```bash +score-k8s completion fish +``` + +#### `powershell` + +Generate completions for powershell + +```bash +score-k8s completion powershell +``` +#### Flags + +The `completion` command can be combined with the following flags + +#### `--help` | `-h` + +Displays help information for `completion`, providing a short description of the command along with sub-commands and compatible flags. + +```bash +score-k8s completion --help +``` + ## `help` The help command provides information on all commands. From 357c214d468aca50330fbb5a539da4002cce709d Mon Sep 17 00:00:00 2001 From: Somsubhra Bairi Date: Thu, 17 Oct 2024 11:48:18 +0530 Subject: [PATCH 2/3] #51 Fix formatting in the score-k8s completion doc Signed-off-by: Somsubhra Bairi --- content/en/docs/score implementation/score-k8s.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/en/docs/score implementation/score-k8s.md b/content/en/docs/score implementation/score-k8s.md index beaf8599..67e519d0 100644 --- a/content/en/docs/score implementation/score-k8s.md +++ b/content/en/docs/score implementation/score-k8s.md @@ -190,6 +190,7 @@ Generate completions for powershell ```bash score-k8s completion powershell ``` + #### Flags The `completion` command can be combined with the following flags From 7e1b7d5c2d035f68fc94cfe87023412c51afed42 Mon Sep 17 00:00:00 2001 From: Somsubhra Bairi Date: Thu, 17 Oct 2024 17:44:58 +0530 Subject: [PATCH 3/3] score-k8s#51 Update the score-k8s completion command documentation in the new page Signed-off-by: Somsubhra Bairi --- .../score implementation/score-k8s/cli.md | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/content/en/docs/score implementation/score-k8s/cli.md b/content/en/docs/score implementation/score-k8s/cli.md index f5ae31bb..ff4a0e33 100644 --- a/content/en/docs/score implementation/score-k8s/cli.md +++ b/content/en/docs/score implementation/score-k8s/cli.md @@ -107,6 +107,58 @@ Displays help information for `generate`, providing a short description of the c score-k8s generate --help ``` +## `completion` + +Generate the autocompletion script for `score-k8s` for the specified shell. See each sub-command's help for details on how to use the generated script. + +#### Sub-Commands + +The `completion` commands supports the following sub-commands. + +#### `bash` + +Generate completions for bash + +```bash +score-k8s completion bash +``` + +#### `zsh` + +Generate completions for zsh + +```bash +score-k8s completion zsh +``` + +#### `fish` + +Generate completions for fish + +```bash +score-k8s completion fish +``` + +#### `powershell` + +Generate completions for powershell + +```bash +score-k8s completion powershell +``` + +#### Flags + +The `completion` command can be combined with the following flags + +#### `--help` | `-h` + +Displays help information for `completion`, providing a short description of the command along with sub-commands and compatible flags. + +```bash +score-k8s completion --help +``` + ## `help` The `help` command provides information on all commands.