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.1.tar.gz (14.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.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: esdbcat-0.1.1.tar.gz
  • Upload date:
  • Size: 14.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.1.tar.gz
Algorithm Hash digest
SHA256 e393143b8b0830366ceb66a18478a5ca1c6e3439bdd03e143aa4eb0ed8034794
MD5 41e30c847dc991ed5f1ba0a7ba80ee78
BLAKE2b-256 3a330343daa0196c756de797652ce380fa3c6aa4460f35443626741fdb043244

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esdbcat-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3a9a4040ed2dfbcab6051b2dc5f0295fa01bad982700ae41de638749ee78d5e5
MD5 90dd5badcf005cb529b14b1a16508dfc
BLAKE2b-256 170e828247ddb578a72aa2e0deeb814573d66353d4ea85df7b9ebd81e33d9083

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