Hatchet Files

Overview

Added

• Added pause and unpause methods to the workflows client (hatchet.workflows.pause(workflow_id, queue_ttl:)) and to workflows (workflow.pause(queue_ttl:)). queue_ttl is how long runs stay queued while the workflow is paused, in seconds or as a duration string, and the behavior (QUEUE or DROP) for cron and scheduled runs triggered while paused can optionally be set, both defaulting to QUEUE.

Documentation for agents

The linked pages serve plain markdown for tools and agents. Full docs index: https://docs.hatchet.run/llms.txt

Setup and local development:

• Quickstart: https://docs.hatchet.run/v1/quickstart.md
• Running Hatchet locally: https://docs.hatchet.run/v1/running-locally.md

Core concepts:

• Tasks: https://docs.hatchet.run/v1/tasks.md
• Workers: https://docs.hatchet.run/v1/workers.md
• Running tasks: https://docs.hatchet.run/v1/running-your-task.md
• DAGs: https://docs.hatchet.run/v1/directed-acyclic-graphs.md
• Durable execution: https://docs.hatchet.run/v1/durable-execution.md

Flow control:

• Concurrency: https://docs.hatchet.run/v1/concurrency.md
• Rate limits: https://docs.hatchet.run/v1/rate-limits.md
• Retries: https://docs.hatchet.run/v1/retry-policies.md
• Idempotency: https://docs.hatchet.run/v1/idempotency.md
• CEL expressions: https://docs.hatchet.run/v1/cel-expressions.md

Ruby SDK reference (overview: https://docs.hatchet.run/reference/ruby.md):

• CEL: https://docs.hatchet.run/reference/ruby/feature-clients/cel.md (guide: https://docs.hatchet.run/v1/cel-expressions.md)
• Crons: https://docs.hatchet.run/reference/ruby/feature-clients/cron.md (guide: https://docs.hatchet.run/v1/cron-runs.md)
• Events: https://docs.hatchet.run/reference/ruby/feature-clients/events.md (guide: https://docs.hatchet.run/v1/events.md)
• Filters: https://docs.hatchet.run/reference/ruby/feature-clients/filters.md (guide: https://docs.hatchet.run/v1/events.md)
• Logs: https://docs.hatchet.run/reference/ruby/feature-clients/logs.md (guide: https://docs.hatchet.run/v1/logging.md)
• Metrics: https://docs.hatchet.run/reference/ruby/feature-clients/metrics.md (guide: https://docs.hatchet.run/v1/prometheus-metrics.md)
• Rate Limits: https://docs.hatchet.run/reference/ruby/feature-clients/rate_limits.md (guide: https://docs.hatchet.run/v1/rate-limits.md)
• Runs: https://docs.hatchet.run/reference/ruby/feature-clients/runs.md (guide: https://docs.hatchet.run/v1/running-your-task.md)
• Scheduled Runs: https://docs.hatchet.run/reference/ruby/feature-clients/scheduled.md (guide: https://docs.hatchet.run/v1/scheduled-runs.md)
• Tenant: https://docs.hatchet.run/reference/ruby/feature-clients/tenant.md
• Workers: https://docs.hatchet.run/reference/ruby/feature-clients/workers.md (guide: https://docs.hatchet.run/v1/workers.md)
• Workflows: https://docs.hatchet.run/reference/ruby/feature-clients/workflows.md (guide: https://docs.hatchet.run/v1/tasks.md)

Installation

Add this line to your application's Gemfile:

:::ruby
gem 'hatchet'

And then execute:

:::bash
bundle install

Or install it yourself as:

:::bash
gem install hatchet

Documentation

For detailed documentation, examples, and best practices, visit:

• Hatchet Documentation
• Examples

What's Changed?