Skip to content

Commit e8fdd90

Browse files
committed
adds note about running cli in windows
1 parent 6de9bb9 commit e8fdd90

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

exercises/hello-workflow/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,22 @@ $ temporal workflow start \
6464
--workflow-id my-first-workflow \
6565
--input '"Mason"'
6666
```
67+
Notice the quoting for the input value, which has double quotes inside of single quotes. The input passed to the `temporal` command must be provided in JSON format and the quoting used here is necessary to pass the value through the shell and into the Workflow in the correct format.
6768

6869
Note that this command starts the Workflow, but it does not wait for it to complete or show the result.
70+
6971
If you have time, continue with the optional part of the exercise below to see how to view the result using `temporal`.
7072

73+
### Using the CLI to Start a Workflow with Windows
74+
75+
The mix of single and double quotes we currently have pertains to UNIX-style shells. However, If you are running the Temporal CLI in Windows (such as Powershell), you will need to use Windows-style quote escaping like this:
76+
77+
```
78+
temporal workflow start --type GreetSomeone --task-queue greeting-tasks --workflow-id my-first-workflow --input '\"Mason\"'
79+
```
80+
81+
This is a general Windows approach for handling quotes in parameters, not something specific to Temporal.
82+
7183
## Part E (Optional): Display the Result
7284

7385
You can run the following command to display the result of a Workflow Execution:

0 commit comments

Comments
 (0)