Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ This is the official command-line interface (CLI) for interacting with the
[Oasis Runtime SDK]:
https://github.com/oasisprotocol/oasis-sdk/tree/main/runtime-sdk

## Installation

For multiple Oasis CLI installation methods, please
refer to the [Setup Guide](docs/setup.mdx).

## Building

To build the CLI, run the following:
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,6 @@ It boasts a number of handy features:
calls
- debugging tools for deployed Wasm contracts
- inspection of blocks, transactions, results and events
- install via
[GitHub Action](https://github.com/oasisprotocol/setup-cli-action)

39 changes: 38 additions & 1 deletion docs/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ import TabItem from '@theme/TabItem';
## Download and Run

The Oasis team provides CLI binaries for Linux,
macOS and Windows operating systems.
macOS and Windows operating systems, as well as
a GitHub Action for CI/CD installs.
If you want to run it on another platform,
you can [build the CLI from source][cli-source].

Expand Down Expand Up @@ -140,6 +141,42 @@ follow the instructions for **your platform** below:
oasis --version
```
</TabItem>

<TabItem value="gh-action" label="GitHub Action">
To setup Oasis CLI for GitHub CI/CD workflows, we recommend using
our [setup-cli-action](https://github.com/oasisprotocol/setup-cli-action)
GitHub Action.

#### Setup

Simply add a Setup Oasis CLI step to your workflow:

```yaml
steps:
- name: Setup Oasis CLI
uses: oasisprotocol/setup-cli-action
```

#### Verify

```yaml
- name: Check Oasis CLI version
run: oasis --version
```

#### Configuration

Optionally you can use the version parameter to install a different version of the CLI.

```yaml
steps:
- name: Setup Oasis CLI
uses: oasisprotocol/setup-cli-action
with:
version: '0.14.3'
```
</TabItem>

</Tabs>

## Update
Expand Down
Loading