Skip to content

Commit 486cbfc

Browse files
authored
Included CLI and UI sections into README (#9)
* Updated urls to internal in the README. Added section about Cadence UI * Added CLI to README * Updated README to not include internal links * PR review feedback
1 parent b9f5b6c commit 486cbfc

File tree

1 file changed

+38
-4
lines changed

1 file changed

+38
-4
lines changed

README.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Java Cadence Samples
22
These samples demonstrate various capabilities of Java Cadence client and server. You can learn more about Cadence at:
3-
* Cadence: https://github.com/uber/cadence
4-
* Java Cadence Client: https://github.com/uber-java/cadence-client
5-
* Go Cadence Client: https://github.com/uber-go/cadence-client
3+
* [Cadence Service](https://github.com/uber/cadence)
4+
* [Cadence Java Client](https://github.com/uber-java/cadence-client)
5+
* [Go Cadence Client](https://github.com/uber-go/cadence-client)
66

77
## Overview of the Samples
88

@@ -63,10 +63,44 @@ If this does not work, see the instructions for running Cadence Server at https:
6363

6464
## Register the Domain
6565

66-
To register the domain, run the follownig command once before running any samples:
66+
To register the *sample* domain, run the following command once before running any samples:
6767

6868
./gradlew -q execute -PmainClass=com.uber.cadence.samples.common.RegisterDomain
6969

70+
## See Cadence UI
71+
72+
The Cadence Server running in a docker container includes a Web UI.
73+
74+
Connect to [http://localhost:8088](http://localhost:8088).
75+
76+
Enter the *sample* domain. You'll see a "No Results" page. After running any sample, change the
77+
filter in the
78+
top right corner from "Open" to "Closed" to see the list of the completed workflows.
79+
80+
Click on a *RUN ID* of a workflow to see more details about it. Try different view formats to get a different level
81+
of details about the execution history.
82+
83+
## Install Cadence CLI
84+
85+
Check out [Cadence Service](https://github.com/uber/cadence) and run **make bins**.
86+
CLI executable named **cadence** will be in the root directory.
87+
88+
To not pass the domain on every command set the following environment variable:
89+
90+
export CADENCE_CLI_DOMAIN=sample
91+
92+
After the CADENCE_CLI_DOMAIN is set, to list closed workflow executions run:
93+
94+
cadence workflow list
95+
96+
To see a history of a particular workflow execution run:
97+
98+
cadence workflow showid <WorkflowID>
99+
100+
To see a stack trace of a currently running workflow execution run:
101+
102+
./cadence workflow stack -w <WorkflowID>
103+
70104
## Run the samples
71105

72106
Each sample has specific requirements for running it. The following sections contain information about

0 commit comments

Comments
 (0)