Skip to content

Commit 49dff6e

Browse files
authored
Updates for README (#80)
1 parent 78cbd21 commit 49dff6e

1 file changed

Lines changed: 36 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1-
# Temporal Cloud CLI
1+
# Temporal Cloud CLI (Pre-release)
22

3-
Plugin for the Temporal command-line interface to work with [Temporal Cloud](https://docs.temporal.io/cloud)
3+
Plugin for the Temporal command-line interface to work with [Temporal Cloud](https://docs.temporal.io/cloud).
4+
5+
> **Pre-release:** This plugin is offered as a pre-release and is subject to change. Please reach out to [Temporal Support](https://support.temporal.io/) if you have questions.
6+
7+
## Prerequisites
8+
9+
- A [Temporal Cloud](https://docs.temporal.io/cloud) account.
10+
- The [`temporal` CLI](https://temporal.io/setup/install-temporal-cli) installed and on your `PATH`. The Cloud CLI runs as a plugin to it.
411

512
## Quick install
613

@@ -10,20 +17,37 @@ Plugin for the Temporal command-line interface to work with [Temporal Cloud](htt
1017

1118
### Install via download
1219

13-
1. Install the [`temporal` CLI](https://temporal.io/setup/install-temporal-cli)
14-
2. Download the [latest version](https://github.com/temporalio/cloud-cli/releases/latest) for your OS and architecture:
15-
3. Extract the downloaded archive.
16-
4. Add the `temporal-cloud` binary to your `PATH` (`temoporal-cloud.exe` for Windows).
20+
1. Download the [latest version](https://github.com/temporalio/cloud-cli/releases/latest) for your OS and architecture.
21+
2. Extract the downloaded archive.
22+
3. Add the `temporal-cloud` binary to your `PATH` (`temporal-cloud.exe` for Windows).
1723

1824
### Build
1925

20-
1. Install the [`temporal` CLI](https://temporal.io/setup/install-temporal-cli)
21-
2. Install [Go](https://go.dev/doc/install) (check [go.mod](./go.mod) for the version)
22-
3. Clone repository
23-
4. Switch to cloned directory, and run `go build ./cmd/temporal-cloud`
26+
1. Install [Go](https://go.dev/doc/install) (check [go.mod](./go.mod) for the version).
27+
2. Clone this repository.
28+
3. From the cloned directory, run `make build` (or `go build ./cmd/temporal-cloud`).
2429

25-
The executable will be at `temporal-cloud` (`temporal-cloud.exe` for Windows).
30+
The executable will be at `temporal-cloud` (`temporal-cloud.exe` for Windows). Add it to your `PATH` so the `temporal` CLI can discover it.
2631

2732
## Usage
2833

29-
Once installed, invoke the plugin via `temporal cloud`
34+
Once installed, invoke the plugin via `temporal cloud`.
35+
36+
### Authenticate
37+
38+
```sh
39+
temporal cloud login # browser-based OAuth login
40+
temporal cloud whoami # confirm the authenticated identity
41+
```
42+
43+
Alternatively, pass an API key directly to any command with `--api-key`.
44+
45+
### Examples
46+
47+
```sh
48+
temporal cloud namespace list
49+
temporal cloud namespace get --namespace <namespace>
50+
temporal cloud namespace retention get --namespace <namespace>
51+
```
52+
53+
Run `temporal cloud --help` (or `temporal cloud <command> --help`) to see all available commands and flags.

0 commit comments

Comments
 (0)