Skip to content
TxPipe Docs

Quick Start

This page takes you from nothing to live Cardano data in a couple of minutes. You don’t need your own node — the first step connects to a public relay.

  1. Install Oura. Grab the pre-built binary for your platform (no toolchain required):

    Terminal window
    curl --proto '=https' --tlsv1.2 -LsSf https://github.com/txpipe/oura/releases/latest/download/oura-installer.sh | sh

    Manual downloads and details are on the Binary Releases page.

  2. Watch live chain data. Point oura watch at a public mainnet relay and see events scroll by in your terminal:

    Terminal window
    oura watch backbone.mainnet.cardanofoundation.org:3001 --bearer tcp

    That’s the fastest way to confirm Oura works. watch is a read-only, throttled view meant for eyeballing the chain — see the watch command for its options.

  3. Run a real pipeline. For anything beyond watching, you write a daemon.toml describing a source, filters, and a sink. This one reads from the same relay, decodes each block into transactions, and prints them to stdout:

    daemon.toml
    [source]
    type = "N2N"
    peers = ["backbone.mainnet.cardanofoundation.org:3001"]
    

    [intersect]
    type = "Tip"
    

    [[filters]]
    type = "SplitBlock"
    

    [[filters]]
    type = "ParseCbor"
    

    [sink]
    type = "Stdout"

    Then run it in daemon mode:

    Terminal window
    oura daemon --config daemon.toml

Starting from Tip means you only see new blocks as they’re produced. To replay history instead, change the [intersect] block — see Intersect options.

Where to go next

  • How it works — the pipeline model, events, and rollbacks in one page. Worth reading before you build a consumer.
  • Sinks — send events to a file, message broker, database, or cloud service instead of stdout.
  • Runnable examples and Recipes — ready-to-run projects and copy-paste configs for every source, filter, and sink.