From b4fd1172be8c814e41220fad4b299a6c2111ae74 Mon Sep 17 00:00:00 2001 From: James Chung Date: Fri, 14 Apr 2023 02:57:43 -0500 Subject: [PATCH] docs: :memo: update documentation --- docs/cprl.md | 2 +- docs/cprl_codecommit.md | 2 +- docs/cprl_codecommit_branch.md | 2 +- docs/cprl_codecommit_branch_remove.md | 2 +- docs/cprl_codecommit_pr.md | 2 +- docs/cprl_codecommit_pr_approve.md | 2 +- docs/cprl_codecommit_pr_close.md | 2 +- docs/cprl_codecommit_pr_create.md | 2 +- docs/cprl_codecommit_pr_diff.md | 2 +- docs/cprl_codecommit_pr_list.md | 2 +- docs/cprl_completion.md | 2 +- docs/cprl_completion_bash.md | 2 +- docs/cprl_completion_fish.md | 2 +- docs/cprl_completion_powershell.md | 2 +- docs/cprl_completion_zsh.md | 2 +- docs/cprl_console.md | 2 +- docs/cprl_console_open.md | 6 ++--- docs/cprl_credentials.md | 4 +-- docs/cprl_credentials_assume.md | 2 +- docs/cprl_credentials_list.md | 2 +- docs/cprl_credentials_output.md | 9 ++++--- docs/cprl_credentials_remove.md | 35 +++++++++++++++++++++++++++ 22 files changed, 63 insertions(+), 27 deletions(-) create mode 100644 docs/cprl_credentials_remove.md diff --git a/docs/cprl.md b/docs/cprl.md index bc58c26..4c92dd6 100644 --- a/docs/cprl.md +++ b/docs/cprl.md @@ -22,4 +22,4 @@ cprl [flags] * [cprl console](cprl_console.md) - AWS console * [cprl credentials](cprl_credentials.md) - AWS credentials -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit.md b/docs/cprl_codecommit.md index e529062..05de709 100644 --- a/docs/cprl_codecommit.md +++ b/docs/cprl_codecommit.md @@ -27,4 +27,4 @@ CodeCommit * [cprl codecommit branch](cprl_codecommit_branch.md) - Manage branches * [cprl codecommit pr](cprl_codecommit_pr.md) - Manage PRs -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_branch.md b/docs/cprl_codecommit_branch.md index 4413a78..e3c8073 100644 --- a/docs/cprl_codecommit_branch.md +++ b/docs/cprl_codecommit_branch.md @@ -26,4 +26,4 @@ Manage branches * [cprl codecommit](cprl_codecommit.md) - CodeCommit * [cprl codecommit branch remove](cprl_codecommit_branch_remove.md) - Remove branches -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_branch_remove.md b/docs/cprl_codecommit_branch_remove.md index e4f0a2e..b08bf29 100644 --- a/docs/cprl_codecommit_branch_remove.md +++ b/docs/cprl_codecommit_branch_remove.md @@ -38,4 +38,4 @@ cprl codecommit branch remove [flags] * [cprl codecommit branch](cprl_codecommit_branch.md) - Manage branches -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_pr.md b/docs/cprl_codecommit_pr.md index 0a6ab78..79b7e6b 100644 --- a/docs/cprl_codecommit_pr.md +++ b/docs/cprl_codecommit_pr.md @@ -30,4 +30,4 @@ Manage PRs * [cprl codecommit pr diff](cprl_codecommit_pr_diff.md) - Diff PRs * [cprl codecommit pr list](cprl_codecommit_pr_list.md) - List PRs -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_pr_approve.md b/docs/cprl_codecommit_pr_approve.md index 18078f7..d44868a 100644 --- a/docs/cprl_codecommit_pr_approve.md +++ b/docs/cprl_codecommit_pr_approve.md @@ -39,4 +39,4 @@ cprl codecommit pr approve [flags] * [cprl codecommit pr](cprl_codecommit_pr.md) - Manage PRs -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_pr_close.md b/docs/cprl_codecommit_pr_close.md index f53751b..9b50c60 100644 --- a/docs/cprl_codecommit_pr_close.md +++ b/docs/cprl_codecommit_pr_close.md @@ -39,4 +39,4 @@ cprl codecommit pr close [flags] * [cprl codecommit pr](cprl_codecommit_pr.md) - Manage PRs -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_pr_create.md b/docs/cprl_codecommit_pr_create.md index 88f8803..7bd3522 100644 --- a/docs/cprl_codecommit_pr_create.md +++ b/docs/cprl_codecommit_pr_create.md @@ -38,4 +38,4 @@ cprl codecommit pr create [flags] * [cprl codecommit pr](cprl_codecommit_pr.md) - Manage PRs -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_pr_diff.md b/docs/cprl_codecommit_pr_diff.md index bee2468..db222e3 100644 --- a/docs/cprl_codecommit_pr_diff.md +++ b/docs/cprl_codecommit_pr_diff.md @@ -39,4 +39,4 @@ cprl codecommit pr diff [flags] * [cprl codecommit pr](cprl_codecommit_pr.md) - Manage PRs -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_codecommit_pr_list.md b/docs/cprl_codecommit_pr_list.md index 4f163f6..76e85fc 100644 --- a/docs/cprl_codecommit_pr_list.md +++ b/docs/cprl_codecommit_pr_list.md @@ -39,4 +39,4 @@ cprl codecommit pr list [flags] * [cprl codecommit pr](cprl_codecommit_pr.md) - Manage PRs -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_completion.md b/docs/cprl_completion.md index bac8fca..a442412 100644 --- a/docs/cprl_completion.md +++ b/docs/cprl_completion.md @@ -29,4 +29,4 @@ See each sub-command's help for details on how to use the generated script. * [cprl completion powershell](cprl_completion_powershell.md) - Generate the autocompletion script for powershell * [cprl completion zsh](cprl_completion_zsh.md) - Generate the autocompletion script for zsh -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_completion_bash.md b/docs/cprl_completion_bash.md index 046c983..2c2ffe3 100644 --- a/docs/cprl_completion_bash.md +++ b/docs/cprl_completion_bash.md @@ -48,4 +48,4 @@ cprl completion bash * [cprl completion](cprl_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_completion_fish.md b/docs/cprl_completion_fish.md index 1e70608..b195c13 100644 --- a/docs/cprl_completion_fish.md +++ b/docs/cprl_completion_fish.md @@ -39,4 +39,4 @@ cprl completion fish [flags] * [cprl completion](cprl_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_completion_powershell.md b/docs/cprl_completion_powershell.md index 3b3f781..7f9d8e2 100644 --- a/docs/cprl_completion_powershell.md +++ b/docs/cprl_completion_powershell.md @@ -36,4 +36,4 @@ cprl completion powershell [flags] * [cprl completion](cprl_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_completion_zsh.md b/docs/cprl_completion_zsh.md index b9fe119..aadd531 100644 --- a/docs/cprl_completion_zsh.md +++ b/docs/cprl_completion_zsh.md @@ -50,4 +50,4 @@ cprl completion zsh [flags] * [cprl completion](cprl_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_console.md b/docs/cprl_console.md index 47df4fd..e2c62ba 100644 --- a/docs/cprl_console.md +++ b/docs/cprl_console.md @@ -27,4 +27,4 @@ AWS console * [cprl](cprl.md) - cprl * [cprl console open](cprl_console_open.md) - opens AWS console -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_console_open.md b/docs/cprl_console_open.md index aee2c9c..d29cbd5 100644 --- a/docs/cprl_console_open.md +++ b/docs/cprl_console_open.md @@ -19,8 +19,8 @@ cprl console open [flags] ### Options ``` - -h, --help help for open - -p, --prompt prompt user with suggested profiles + -h, --help help for open + -i, --interactive interactive prompt with suggested profiles ``` ### Options inherited from parent commands @@ -35,4 +35,4 @@ cprl console open [flags] * [cprl console](cprl_console.md) - AWS console -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_credentials.md b/docs/cprl_credentials.md index 5bbc61b..2032390 100644 --- a/docs/cprl_credentials.md +++ b/docs/cprl_credentials.md @@ -25,8 +25,8 @@ AWS credentials * [cprl](cprl.md) - cprl * [cprl credentials assume](cprl_credentials_assume.md) - assume AWS role -* [cprl credentials clear](cprl_credentials_clear.md) - clears AWS credentials * [cprl credentials list](cprl_credentials_list.md) - lists AWS profiles * [cprl credentials output](cprl_credentials_output.md) - outputs AWS credentials +* [cprl credentials remove](cprl_credentials_remove.md) - remove AWS credentials -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_credentials_assume.md b/docs/cprl_credentials_assume.md index 279e770..ba4b3c5 100644 --- a/docs/cprl_credentials_assume.md +++ b/docs/cprl_credentials_assume.md @@ -39,4 +39,4 @@ cprl credentials assume [flags] * [cprl credentials](cprl_credentials.md) - AWS credentials -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_credentials_list.md b/docs/cprl_credentials_list.md index 4b232d9..9c61d55 100644 --- a/docs/cprl_credentials_list.md +++ b/docs/cprl_credentials_list.md @@ -34,4 +34,4 @@ cprl credentials list [flags] * [cprl credentials](cprl_credentials.md) - AWS credentials -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_credentials_output.md b/docs/cprl_credentials_output.md index bdda66b..5ffb87e 100644 --- a/docs/cprl_credentials_output.md +++ b/docs/cprl_credentials_output.md @@ -32,9 +32,10 @@ cprl credentials output [flags] ### Options ``` - -h, --help help for output - --json output in json format - -s, --style string output style [unix, powershell, windows] (default "unix") + -h, --help help for output + -i, --interactive interactive prompt with suggested profiles + --json output in json format + -o, --output-style string output style [unix, powershell, windows] (default "unix") ``` ### Options inherited from parent commands @@ -48,4 +49,4 @@ cprl credentials output [flags] * [cprl credentials](cprl_credentials.md) - AWS credentials -###### Auto generated by spf13/cobra on 11-Apr-2023 +###### Auto generated by spf13/cobra on 14-Apr-2023 diff --git a/docs/cprl_credentials_remove.md b/docs/cprl_credentials_remove.md new file mode 100644 index 0000000..d9e7d17 --- /dev/null +++ b/docs/cprl_credentials_remove.md @@ -0,0 +1,35 @@ +## cprl credentials remove + +remove AWS credentials + +``` +cprl credentials remove [flags] +``` + +### Examples + +``` + $ cprl credentials remove + Select profiles to remove: + > [✗] dev + enter: select | tab: confirm | left: none | right: all| type to filter +``` + +### Options + +``` + -h, --help help for remove +``` + +### Options inherited from parent commands + +``` + --aws-profile string overrides [aws-profile] value in cprl.yaml + --profile string references a profile in cprl.yaml (default "default") +``` + +### SEE ALSO + +* [cprl credentials](cprl_credentials.md) - AWS credentials + +###### Auto generated by spf13/cobra on 14-Apr-2023