Skip to main content

EventStore CLI tool for reading and following streams

Project description

esdbcat

PyPI version License Python Versions

A command-line tool for reading EventStore streams, inspired by kafkacat.

AI Code Notice

This repository was near-entirely created by Claude 3.5 Sonnet. Good job Sonnet!

Installation

pip install esdbcat

Usage

Read all events from a stream:

esdbcat my-stream

The output will be JSON lines with event data and metadata (by default):

{
  "data": {
    "message": "Hello World"
  },
  "metadata": {
    "id": "1234-5678-90ab-cdef",
    "type": "TestEvent",
    "stream": "my-stream"
  }
}

Follow a stream for new events:

esdbcat -f my-stream

Start reading from the end of the stream:

esdbcat -o end -f my-stream

Read only the last event:

esdbcat -o last my-stream

Exit after consuming 10 events:

esdbcat -c 10 my-stream

Read the special $all stream:

esdbcat $all

Quiet mode (suppress informational messages):

esdbcat -q my-stream

Verbose mode for debugging:

esdbcat -v my-stream

Connect to a specific EventStore instance:

esdbcat --host eventstore.example.com:2113 my-stream

Or use a full connection URL:

esdbcat --url "esdb://eventstore.example.com:2113?tls=false" my-stream

Read events without metadata:

esdbcat --no-metadata my-stream

Connect with authentication:

esdbcat --url "esdb://admin:changeit@localhost:2113?tls=false" my-stream

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

esdbcat-0.1.2.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

esdbcat-0.1.2-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file esdbcat-0.1.2.tar.gz.

File metadata

  • Download URL: esdbcat-0.1.2.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for esdbcat-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2a08fc677c17de082b5a3436472d92bdf79540dedcc77a88d79181c0382e869f
MD5 e18cfc71f16d00267f04f55368545dc3
BLAKE2b-256 30f526eceee21facc3f722250350af52ec315c56cedc5a23ae3bd6644f796eaf

See more details on using hashes here.

File details

Details for the file esdbcat-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: esdbcat-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for esdbcat-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c61452ab9075ece020e73e14654f62f31e48503559667602f00c5182d9bc2176
MD5 befde65728ef5749ceae7446da7e93e4
BLAKE2b-256 c677e85b0db0cb085d33991931041bfc997504d9a41b3b6f21546557fae89ddb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page