Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Merged
merged 1 commit into from
Mar 28, 2024
+36 −2
Merged

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions README.md
View file
Open in desktop
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>
```