Quickstart

Log in to the dashboard.

Create a new organization and generate a new authentication token.

• Using Homebrew
• Using Cargo
• From Release Binaries

brew install s2-streamstore/s2/s2

The binary should be installed as s2.

export MY_BASIN_NAME="<your basin name>"
s2 create-basin $MY_BASIN_NAME

Check if the basin is active. You should see your basin’s name in the list with an active status:

s2 list-basins

Nothing better than Star Wars to get us a good feeling of how we can exercise append and read sessions and see what data in motion looks like.

We will start by creating a new stream called starwars.

s2 create-stream s2://$MY_BASIN_NAME/starwars

If you remember the good old days of ASCII art, some of you may have streamed Star Wars from towel.blinkenlights.nl on a telnet client!

We will do the same, except we will “append” the movie to our starwars stream, and read from the stream live.

Start by creating a read session like so:

s2 read s2://$MY_BASIN_NAME/starwars -s 0 2> /dev/null

Open another terminal and start an append session:

export MY_BASIN_NAME="<your basin name>" # Set the basin name for new terminal
nc towel.blinkenlights.nl 23 | s2 append s2://$MY_BASIN_NAME/starwars

Go back to the previous terminal with read session to enjoy the movie: