For the complete documentation index, see /llms.txt. This page is also available as raw Markdown at /develop/ruby.md. Append .md to any page URL to fetch its Markdown.

Ruby SDK developer guide

View Markdown

Install and get started

You can find detailed installation instructions for the Ruby SDK in the Quickstart.

There's also a short walkthrough of how to use the Temporal primitives (Activities, Workflows, and Workers) to build and run a Temporal application to get you up and running.

Once your local Temporal Service is set up, continue building with the following resources:

• Workflow basics
• Activity basics
• Start an Activity Execution
• Run Worker processes

From there, you can dive deeper into any of the Temporal primitives to start building Workflows that fit your use cases.

Workflows

• Workflow basics
• Child Workflows
• Continue-As-New
• Cancellation
• Timeouts
• Message Passing
• Schedules
• Timers
• Futures
• Dynamic Workflow
• Versioning

Activities

• Activity basics
• Activity Execution
• Standalone Activities
• Timeouts
• Asynchronous Activity completion
• Dynamic Activity
• Benign exceptions

Workers

• Worker processes
• Observability

Temporal Client

• Temporal Client

Platform

• Observability
• Enriching the UI

Integrations

• Rails integration

Best practices

• Error handling
• Testing
• Debugging
• Converters and encryption

Temporal Ruby technical resources

• Ruby SDK Quickstart - Setup Guide
• Ruby SDK Code Samples
• Ruby API Documentation
• Ruby SDK GitHub
• Temporal 101 in Ruby Free Course

Get connected with the Temporal Ruby community

• Temporal Ruby Community Slack
• Ruby SDK Forum