From a656cee9a6aa138cc9c88314bb428bb52f02f4fd Mon Sep 17 00:00:00 2001 From: Deepesha Burse Date: Mon, 7 Aug 2023 23:48:40 +0530 Subject: [PATCH 1/5] docs: add documentation for oras completion Signed-off-by: Deepesha Burse --- docs/commands/oras_completion.mdx | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/commands/oras_completion.mdx diff --git a/docs/commands/oras_completion.mdx b/docs/commands/oras_completion.mdx new file mode 100644 index 00000000..e7e2b406 --- /dev/null +++ b/docs/commands/oras_completion.mdx @@ -0,0 +1,26 @@ +--- +title: oras completion +sidebar_position: 45 +--- + +# oras completion + +`oras completion` helps to generate the autocompletion script for oras for the specified shell. + +Based on the shell that you use (bash/fish/powershell/zsh), please run: + +``` +oras completion [shell] --help +``` + +This will return an output on how you can set up `oras completion` for your shell. + +For example, the following steps are to be followed to set it up for `zsh`: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +$ source <(oras completion zsh); compdef _oras oras +$ oras completion zsh > $(brew --prefix)/share/zsh/site-functions/_oras +``` + +After setting it up, you can hit `tab` to autocomplete your commands. \ No newline at end of file From c15b9b43b464b58245c167dc6960bed9ce1460d1 Mon Sep 17 00:00:00 2001 From: Deepesha Burse Date: Tue, 8 Aug 2023 15:50:24 +0530 Subject: [PATCH 2/5] docs: add flags Signed-off-by: Deepesha Burse --- docs/commands/oras_completion.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/commands/oras_completion.mdx b/docs/commands/oras_completion.mdx index e7e2b406..2c090990 100644 --- a/docs/commands/oras_completion.mdx +++ b/docs/commands/oras_completion.mdx @@ -23,4 +23,11 @@ $ source <(oras completion zsh); compdef _oras oras $ oras completion zsh > $(brew --prefix)/share/zsh/site-functions/_oras ``` -After setting it up, you can hit `tab` to autocomplete your commands. \ No newline at end of file +After setting it up, you can hit `tab` to autocomplete your commands. + +## Options + +``` + -h, --help help for [shell] + --no-descriptions disable completion descriptions +``` \ No newline at end of file From 35293f2861511d2e441ce54024318664f19c1e55 Mon Sep 17 00:00:00 2001 From: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com> Date: Thu, 10 Aug 2023 19:34:58 +0530 Subject: [PATCH 3/5] Update docs/commands/oras_completion.mdx Co-authored-by: Terry Howe Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com> --- docs/commands/oras_completion.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/commands/oras_completion.mdx b/docs/commands/oras_completion.mdx index 2c090990..683d6643 100644 --- a/docs/commands/oras_completion.mdx +++ b/docs/commands/oras_completion.mdx @@ -15,7 +15,7 @@ oras completion [shell] --help This will return an output on how you can set up `oras completion` for your shell. -For example, the following steps are to be followed to set it up for `zsh`: +For example, the following steps are to be followed to set it up for `zsh` on macOS: ``` $ echo "autoload -U compinit; compinit" >> ~/.zshrc From a677bbd01506b958df8dcb1c9fa58825966532e1 Mon Sep 17 00:00:00 2001 From: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com> Date: Thu, 10 Aug 2023 19:35:08 +0530 Subject: [PATCH 4/5] Update docs/commands/oras_completion.mdx Co-authored-by: Terry Howe Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com> --- docs/commands/oras_completion.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/commands/oras_completion.mdx b/docs/commands/oras_completion.mdx index 683d6643..d8dc5a41 100644 --- a/docs/commands/oras_completion.mdx +++ b/docs/commands/oras_completion.mdx @@ -5,7 +5,7 @@ sidebar_position: 45 # oras completion -`oras completion` helps to generate the autocompletion script for oras for the specified shell. +`oras completion` helps to generate the autocompletion script for oras for the specified shell and operating system. Based on the shell that you use (bash/fish/powershell/zsh), please run: From 867381a140b29b45de30ce98d2f5cef4efd7a0e7 Mon Sep 17 00:00:00 2001 From: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com> Date: Mon, 14 Aug 2023 23:34:30 +0530 Subject: [PATCH 5/5] Update docs/commands/oras_completion.mdx Co-authored-by: Sajay Antony Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com> --- docs/commands/oras_completion.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/commands/oras_completion.mdx b/docs/commands/oras_completion.mdx index d8dc5a41..683d6643 100644 --- a/docs/commands/oras_completion.mdx +++ b/docs/commands/oras_completion.mdx @@ -5,7 +5,7 @@ sidebar_position: 45 # oras completion -`oras completion` helps to generate the autocompletion script for oras for the specified shell and operating system. +`oras completion` helps to generate the autocompletion script for oras for the specified shell. Based on the shell that you use (bash/fish/powershell/zsh), please run: