Skip to content
This repository has been archived by the owner on Oct 5, 2021. It is now read-only.

Latest commit

 

History

History
321 lines (206 loc) · 5.36 KB

reference.md

File metadata and controls

321 lines (206 loc) · 5.36 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
    • login - login to Choreo
    • connect - connect a source code provider
  • version - get Choreo client version information
  • app - manage apps
    • create - create an application
    • list - list applications
    • deploy - deploy a Ballerina application
    • logs - manage application logs
      • show - show application logs
    • delete - delete an application
    • status - status of an application

chor auth

auth command is used to manage authentication and authorization in Choreo platform.

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 app

app command is used to manage applications created with the Choreo platform.

Synopsis

Manage applications.

Aliases

app

Options

  -h, --help   help for application

Back to Command List

chor app create

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

Synopsis

Create an application.

app create APP_NAME [options]

Examples

$ chor app 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 app list

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

Synopsis

List applications.

app list

Examples

$ chor app list

Options

  -h, --help    help for list

Back to Command List

chor app deploy

app deploy command is used to deploy a Ballerina application to the Choreo platform.

Synopsis

Deploy a Ballerina application.

app deploy GITHUB_URL

Examples

$ chor app deploy https://github.com/someuser/choreo-sample
$ chor app deploy -n my-app https://github.com/someuser/choreo-sample

Options

  -h, --help          help for deploy
  -n, --name string   the name to be used for the created application

Back to Command List

chor app logs

app logs command is used to manage logs of a deployed application.

Synopsis

Manage application logs.

Options

  -h, --help    help for list

Back to Command List

chor app logs show

application logs show APP_ID command is used to show logs of a deployed application.

Synopsis

Show logs of a deployed application. Maximum number of log lines shown is 500. If the number of log lines is not specified 50 lines is shown by default.

app logs show APP_ID

Examples

$ chor app logs show app1234567890abcd

Options

  -n, --number-of-lines     specify number of log lines which should be fetched
  -h, --help                help for list

Back to Command List

chor app delete

app delete command is used to delete an application created in the Choreo platform. It will also remove the app deployment if the application is already deployed.

Synopsis

Delete an application.

app delete APP_ID

Examples

$ chor app delete a123456788901

Options

  -h, --help          help for deploy

chor app status

app status command is used to retrieve the status of an application created in the Choreo platform.

Synopsis

Get status of an application

app status APP_ID

Examples

$ chor app status a123456788901

Options

  -h, --help          help for deploy

Back to Command List

Global flags

  -v, --verbose     verbose output

Back to Command List