Skip to content

Commit

Permalink
Merge pull request #1 from CharukaK/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
kaviththiranga authored Mar 28, 2024
2 parents 80ac913 + 02d04f7 commit 6084c2c
Showing 1 changed file with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# choreo-cli
CLI tool for WSO2 Choreo
# Choreo CLI

Boost Developer Efficiency: A CLI for WSO2 Choreo

## Installation
Download the choreo cli distribution and install.

### Install via script

#### MacOS, Linux, WSL
```bash
curl -o- https://cli.choreo.dev/install.sh | bash
```

#### Windows
```bash
iwr https://cli.choreo.dev/install.ps1 -useb | iex
```

### Download from GitHub
Download the appropriate version from the [releases](https://github.com/wso2/choreo-cli/releases) choreo cli github repository

## Getting started

1. Sign into your choreo account
```bash
choreo login
```
2. List your projects
```bash
choreo list projects
```
3. Describe your projects/components
```bash
choreo describe <project|component>
```

0 comments on commit 6084c2c

Please sign in to comment.