mirror of
https://github.com/siderolabs/talos.git
synced 2025-10-21 20:41:11 +02:00
c24ce2fd5f
Fixes #1565 Examples: ``` $ osctl list -l MODE SIZE(B) LASTMOD NAME drwxr-xr-x 4096 Dec 17 16:37:19 . -rwxr-xr-x 0 Dec 17 16:37:19 .dockerenv drwxr-xr-x 4096 Dec 17 16:35:20 bin drwxr-xr-x 4096 Dec 17 16:37:20 boot drwxr-xr-x 5480 Dec 17 16:37:19 dev drwxr-xr-x 4096 Dec 17 16:37:19 etc drwxr-xr-x 4096 Dec 17 16:35:19 lib drwxr-xr-x 4096 Dec 17 16:35:21 mnt drwxr-xr-x 4096 Dec 17 16:39:17 opt dr-xr-xr-x 0 Dec 17 16:37:19 proc drwxr-x--- 4096 Dec 5 06:39:44 root drwxr-xr-x 4096 Dec 17 16:39:06 run drwxr-xr-x 4096 Dec 17 16:35:20 sbin dr-xr-xr-x 0 Dec 17 16:37:19 sys dtrwxrwxrwx 4096 Dec 17 16:38:05 tmp drwxr-xr-x 4096 Dec 17 16:35:21 usr drwxr-xr-x 4096 Dec 17 16:37:19 var ``` ``` $ osctl list -lH MODE SIZE(B) LASTMOD NAME drwxr-xr-x 4.1 kB 18 minutes ago . -rwxr-xr-x 0 B 18 minutes ago .dockerenv drwxr-xr-x 4.1 kB 20 minutes ago bin drwxr-xr-x 4.1 kB 18 minutes ago boot drwxr-xr-x 5.5 kB 18 minutes ago dev drwxr-xr-x 4.1 kB 18 minutes ago etc drwxr-xr-x 4.1 kB 20 minutes ago lib drwxr-xr-x 4.1 kB 20 minutes ago mnt drwxr-xr-x 4.1 kB 16 minutes ago opt dr-xr-xr-x 0 B 18 minutes ago proc drwxr-x--- 4.1 kB 1 week ago root drwxr-xr-x 4.1 kB 16 minutes ago run drwxr-xr-x 4.1 kB 20 minutes ago sbin dr-xr-xr-x 0 B 18 minutes ago sys dtrwxrwxrwx 4.1 kB 17 minutes ago tmp drwxr-xr-x 4.1 kB 20 minutes ago usr drwxr-xr-x 4.1 kB 18 minutes ago var ``` Signed-off-by: Andrey Smirnov <smirnov.andrey@gmail.com>
68 lines
2.1 KiB
Markdown
68 lines
2.1 KiB
Markdown
<!-- markdownlint-disable -->
|
|
## osctl completion
|
|
|
|
Output shell completion code for the specified shell (bash or zsh)
|
|
|
|
### Synopsis
|
|
|
|
Output shell completion code for the specified shell (bash or zsh).
|
|
The shell code must be evaluated to provide interactive
|
|
completion of osctl commands. This can be done by sourcing it from
|
|
the .bash_profile.
|
|
|
|
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
|
|
|
|
```
|
|
osctl completion SHELL [flags]
|
|
```
|
|
|
|
### Examples
|
|
|
|
```
|
|
# Installing bash completion on macOS using homebrew
|
|
## If running Bash 3.2 included with macOS
|
|
brew install bash-completion
|
|
## or, if running Bash 4.1+
|
|
brew install bash-completion@2
|
|
## If osctl is installed via homebrew, this should start working immediately.
|
|
## If you've installed via other means, you may need add the completion to your completion directory
|
|
osctl completion bash > $(brew --prefix)/etc/bash_completion.d/osctl
|
|
|
|
# Installing bash completion on Linux
|
|
## If bash-completion is not installed on Linux, please install the 'bash-completion' package
|
|
## via your distribution's package manager.
|
|
## Load the osctl completion code for bash into the current shell
|
|
source <(osctl completion bash)
|
|
## Write bash completion code to a file and source if from .bash_profile
|
|
osctl completion bash > ~/.talos/completion.bash.inc
|
|
printf "
|
|
# osctl shell completion
|
|
source '$HOME/.talos/completion.bash.inc'
|
|
" >> $HOME/.bash_profile
|
|
source $HOME/.bash_profile
|
|
# Load the osctl completion code for zsh[1] into the current shell
|
|
source <(osctl completion zsh)
|
|
# Set the osctl completion code for zsh[1] to autoload on startup
|
|
osctl completion zsh > "${fpath[1]}/_osctl"
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
-h, --help help for completion
|
|
```
|
|
|
|
### Options inherited from parent commands
|
|
|
|
```
|
|
--context string Context to be used in command
|
|
-e, --endpoints strings override default endpoints in Talos configuration
|
|
-n, --nodes strings target the specified nodes
|
|
--talosconfig string The path to the Talos configuration file (default "/home/user/.talos/config")
|
|
```
|
|
|
|
### SEE ALSO
|
|
|
|
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
|
|
|