Skip to content

Commit

Permalink
docs: 📝 update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesChung committed Apr 14, 2023
1 parent d469c8a commit b4fd117
Show file tree
Hide file tree
Showing 22 changed files with 63 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/cprl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_branch_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_pr_approve.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_pr_close.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_pr_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_pr_diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_codecommit_pr_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_console.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions docs/cprl_console_open.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
4 changes: 2 additions & 2 deletions docs/cprl_credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_credentials_assume.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/cprl_credentials_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 5 additions & 4 deletions docs/cprl_credentials_output.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
35 changes: 35 additions & 0 deletions docs/cprl_credentials_remove.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit b4fd117

Please sign in to comment.