You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/ruby/set-up-local-ruby.mdx
+22-25Lines changed: 22 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,8 @@ tags:
13
13
---
14
14
15
15
# Quick Start – Ruby SDK
16
-
This guide walks you through setting up the Temporal Ruby SDK and running your first Workflow.
16
+
17
+
This guide walks you through setting up the Temporal Ruby SDK and running your first Workflow.
17
18
In just a few steps, you'll install the SDK, start a local development server, and see a Workflow in action.
18
19
19
20
## 1. Installation
@@ -23,29 +24,29 @@ Install the Temporal SDK using your preferred method.
23
24
<Tabs>
24
25
<TabItemvalue="gemfile"label="Gemfile">
25
26
26
-
```ruby
27
-
gem 'temporalio'
28
-
```
27
+
```ruby
28
+
gem 'temporalio'
29
+
```
29
30
30
-
This approach is used in Ruby projects that manage dependencies with Bundler.
31
+
This approach is used in Ruby projects that manage dependencies with Bundler.
31
32
32
-
To install it, add the line to your project's Gemfile and run `bundle install` in your terminal.
33
-
Bundler will download and install the gem and its dependencies.
33
+
To install it, add the line to your project's Gemfile and run `bundle install` in your terminal.
34
+
Bundler will download and install the gem and its dependencies.
34
35
35
36
</TabItem>
36
37
</Tabs>
37
38
38
39
<Tabs>
39
40
<TabItemvalue="cli"label="Command Line (gem install)">
40
41
41
-
```bash
42
-
gem install temporalio
43
-
```
42
+
```bash
43
+
gem install temporalio
44
+
```
44
45
45
46
</TabItem>
46
47
</Tabs>
47
48
48
-
Both methods will install the same Temporal SDK, which supports Ruby versions 3.2, 3.3, and 3.4.
49
+
Both methods will install the same Temporal SDK, which supports Ruby versions 3.2, 3.3, and 3.4.
49
50
50
51
> **Note:**
51
52
>
@@ -55,10 +56,9 @@ Both methods will install the same Temporal SDK, which supports Ruby versions 3.
55
56
> -`fibers`/`async` are only supported on Ruby **3.3+**.
56
57
> - See [Platform Support](#) for full details.
57
58
58
-
59
59
## 2. Start the Temporal Server Locally
60
60
61
-
With the SDK installed, you’ll need a local Temporal Server to run your Workflows.
61
+
With the SDK installed, you’ll need a local Temporal Server to run your Workflows.
62
62
The easiest way to do this is with [**Temporal CLI**](https://docs.temporal.io/dev-guide/cli/).
63
63
64
64
<TabsgroupId="os"queryString>
@@ -70,7 +70,7 @@ You can install the latest version with [Homebrew](https://brew.sh) using the fo
70
70
brew install temporal
71
71
```
72
72
73
-
</TabItem>
73
+
</TabItem>
74
74
<TabItemvalue="win"label="Windows">
75
75
76
76
To install Temporal CLI on Windows, download the version for your architecture:
@@ -80,18 +80,17 @@ To install Temporal CLI on Windows, download the version for your architecture:
80
80
81
81
Once you've downloaded the file, extract the downloaded archive and add the `temporal.exe` binary to your `PATH`.
82
82
83
-
</TabItem>
83
+
</TabItem>
84
84
<TabItemvalue="linux"label="Linux">
85
85
86
-
87
86
To install Temporal CLI, download the version for your architecture:
88
87
89
88
-[Download Temporal CLI for Linux amd64](https://temporal.download/cli/archive/latest?platform=linux&arch=amd64)
90
89
-[Download Temporal CLI for Linux arm64](https://temporal.download/cli/archive/latest?platform=linux&arch=arm64)
91
90
92
91
Once you've downloaded the file, extract the downloaded archive and add the `temporal` binary to your `PATH` by copying it to a directory like `/usr/local/bin`.
93
92
94
-
</TabItem>
93
+
</TabItem>
95
94
</Tabs>
96
95
97
96
Once installed, run the development server by opening up a new terminal window:
@@ -115,8 +114,7 @@ Leave this running in a separate terminal tab or window while you develop.
115
114
> temporal server start-dev --db-filename my_temporal.db
0 commit comments