Skip to content
This repository has been archived by the owner on Jul 28, 2023. It is now read-only.

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
s1cyan committed May 6, 2020
1 parent 11aaf1c commit 6316f6e
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@ This repo defines a command line interface used by the enterprise, solution, or

### Synopsis

**kabanero** is a command line interface for managing the stacks in a Kabanero
environment, as well as to on-board the people that will use
the environment to build applications.
The Kabenero CLI is a command line interface for managing the stacks in a Kabanero environment to create governed applications for businesses.

Before using the cli please configure the github authorization for the cli service. Steps can be found in the following documentation: https://kabanero.io/docs/ref/general/configuration/github-authorization.html
Before using the CLI please configure the github authorization for the CLI service. Steps can be found in the following documentation: https://kabanero.io/docs/ref/general/configuration/github-authorization.html


Complete documentation is available at https://kabanero.io
Expand All @@ -28,14 +26,15 @@ Complete documentation is available at https://kabanero.io
### SEE ALSO

* [kabanero deactivate](#kabanero-deactivate) - Remove the specified stack from the list of available application types, without deleting it from the Kabanero instance.
* [kabanero describe](#kabanero-describe) - Get more information about the specified stack
* [kabanero list](#kabanero-list) - List all the stacks in the kabanero instance, and their status
* [kabanero login](#kabanero-login) - Will authenticate you to a Kabanero instance
* [kabanero logout](#kabanero-logout) - Disconnect from Kabanero instance
* [kabanero onboard](#kabanero-onboard) - Command to onboard a developer to the Kabanero infrastructure
* [kabanero sync](#kabanero-sync) - sync the stack list
* [kabanero version](#kabanero-version) - Show Kabanero CLI version

###### Auto generated by spf13/cobra on 21-Feb-2020
###### Auto generated by spf13/cobra on 6-May-2020
## kabanero login

Will authenticate you to a Kabanero instance
Expand All @@ -50,7 +49,8 @@ Will authenticate you to a Kabanero instance


```
kabanero login kabanero-url -u Github userid /n PASSWORDPROMPT:GitHub Password|PAT [flags]
kabanero login kabanero-cli-url -u Github userid
At the password prompt, enter your GitHub Password/PAT [flags]
```

### Examples
Expand All @@ -67,8 +67,11 @@ kabanero login kabanero-url -u Github userid /n PASSWORDPROMPT:GitHub Password|P
### Options

```
-h, --help help for login
-u, --username string github username
--certificate-authority string Path to a cert file for the certificate authority
-h, --help help for login
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
-p, --password string github password/PAT. If no password is provided, prompt will appear
-u, --username string github username
```

### Options inherited from parent commands
Expand All @@ -81,7 +84,7 @@ kabanero login kabanero-url -u Github userid /n PASSWORDPROMPT:GitHub Password|P

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 21-Feb-2020
###### Auto generated by spf13/cobra on 6-May-2020
## kabanero logout

Disconnect from Kabanero instance
Expand Down Expand Up @@ -112,7 +115,7 @@ kabanero logout [flags]

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 21-Feb-2020
###### Auto generated by spf13/cobra on 6-May-2020
## kabanero list

List all the stacks in the kabanero instance, and their status
Expand Down Expand Up @@ -142,7 +145,7 @@ kabanero list [flags]

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 21-Feb-2020
###### Auto generated by spf13/cobra on 6-May-2020
## kabanero sync

sync the stack list
Expand Down Expand Up @@ -174,7 +177,7 @@ kabanero sync [flags]

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 21-Feb-2020
###### Auto generated by spf13/cobra on 6-May-2020
## kabanero onboard

Command to onboard a developer to the Kabanero infrastructure
Expand Down Expand Up @@ -205,7 +208,7 @@ kabanero onboard github-id [flags]

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 21-Feb-2020
###### Auto generated by spf13/cobra on 6-May-2020
## kabanero deactivate

Remove the specified stack from the list of available application types, without deleting it from the Kabanero instance.
Expand Down Expand Up @@ -237,4 +240,4 @@ kabanero deactivate stack-name version [flags]

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 21-Feb-2020
###### Auto generated by spf13/cobra on 6-May-2020

0 comments on commit 6316f6e

Please sign in to comment.