Home / Docs

Documentation

Get started

The open-source toolkit is the starting point. Premium packs plug into the same workflow once you need continuous operation.

git clone https://github.com/readyagents/readyagents-core.git
cd readyagents-core
python -m venv .venv
source .venv/bin/activate
pip install -e .
readyagents run examples/calc_pipeline.yaml

Python 3.11+. No API keys needed for that first run.

01

Clone the toolkit

git clone https://github.com/readyagents/readyagents-core.git && cd readyagents-core

02

Install

python -m venv .venv && source .venv/bin/activate && pip install -e . (Python 3.11+)

03

Run a first workflow

readyagents run examples/calc_pipeline.yaml — no API keys needed.

04

Add keys only if you want LLM examples

Copy .env.example to .env and set your own provider key. The first run above works without this.

0.2.0

What’s in the core

Local one-shot runs. Not always-on. These are in readyagents-core 0.2.0:

  • Approval (HITL) — a run can pause for approve or reject, then resume
  • Persist + resume — state is written after each node; continue from the last success
  • Fan-out — parallel branches
  • Include — run another workflow file

Try examples/approval_gate.yaml, examples/fanout_gate.yaml, and examples/include_demo.yaml.

--json prints machine-readable output on run, resume, validate, and runs. --log-level is DEBUG / INFO / WARNING / ERROR.

BYOK

Bring your own API keys

ReadyAgents is designed so you keep provider accounts and spend. The open-source core and premium packs both assume your keys, not ours. Use the key you have.

Next

Want always-on agents?

When a workflow has to stay up, join the waitlist for premium packs instead of stitching operations yourself. Pricing is on a separate page — no invented vertical bundles.