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.3.tar.gz (33.2 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.3-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: esdbcat-0.1.3.tar.gz
  • Upload date:
  • Size: 33.2 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.3.tar.gz
Algorithm Hash digest
SHA256 d0feddaa0a228a4f01fa23e0165e10d27724e4209abd8c088537c01c7b2dc5f5
MD5 392c13998ebcdc0500f8f9d7469ee824
BLAKE2b-256 c5cbbfa6b545aaa06768662afeb1884e996c3c5712920bf37375c322b6230d77

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esdbcat-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.4 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c38c54abfaa473a3b048a11c671ed1b2afcb500c044d28486a465efac908d796
MD5 16d63fa0b2e22f6bca5b330f4650783d
BLAKE2b-256 6318f80a32675efa86b10058c81226f4685086d85a47e4dcd10622cbd1415967

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