-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from CharukaK/patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
36 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
``` |