Skip to content

Latest commit

 

History

History
192 lines (122 loc) · 3.15 KB

reference.md

File metadata and controls

192 lines (122 loc) · 3.15 KB
Raw

Choreo CLI (chor) reference

Choreo CLI (code name $chor) reference is based on Choreo CLI specification

Chor CLI Commands

  • auth - authentication and authorization actions in Choreo
  • version - get Choreo client version information
  • application - manage applications

chor auth

auth command is used to manage authentication and authorization in Choreo platform. Available sub commands include login and connect.

Synopsis

Manage authentication and authorization.

Options

  -h, --help   help for auth

Back to Command List

chor auth login

auth login command can be used to login to Choreo. This is required to perform all the tasks that interact with Choreo.

Synopsis

Login to Choreo.

auth login

Examples

$ chor auth login

Options

  -h, --help   help for login

Back to Command List

chor auth connect

auth connect command is used to connect a source code provider to Choreo. At the moment only GitHub is supported.

Synopsis

Connect a source code provider.

auth connect SOURCE_PROVIDER

Examples

$ chor auth connect github

Options

  -h, --help   help for connect

Back to Command List

chor version

version command can be used to retrieve version information related to the Choreo client. In addition to the CLI version name, Git commit hash, built date and target platform details are also printed.

Synopsis

Get Choreo client version information.

version

Examples

$ chor version
 Version:		0.0.1
 Git commit:		b086b964ae81e8277842fad625784672bb44a3a7
 Built:			2019-08-15T11:06:22+0530
 OS/Arch:		linux/amd64

Options

  -h, --help   help for version

Back to Command List

chor application

application command is used to manage applications created with the Choreo platform. Available sub commands include create and list.

Synopsis

Manage applications.

Aliases

app

Options

  -h, --help   help for application

Back to Command List

chor application create

application create command is used to create a new application with the Choreo platform.

Synopsis

Create an application.

application create APP_NAME [options]

Examples

$ chor application create app1 -d "My first app"

Options

  -d, --description string   Specify description for the application
  -h, --help                 help for create

Back to Command List

chor application list

application list command is used to list applications created with the Choreo platform.

Synopsis

List applications.

application list

Examples

$ chor application list

Options

  -h, --help    help for list

Back to Command List

Global flags

  -v, --verbose     verbose output

Back to Command List