Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#51 Added docs for completion command in score-k8s #124

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions content/en/docs/score implementation/score-k8s/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down