Skip to main content

Documentation Index

Fetch the complete documentation index at: https://s2.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Onboarding

First, log in to the dashboard, create a new organization and issue an access token.

​
Get started with the CLI

1

Install the S2 CLI

This method works on macOS and Linux distributions with Homebrew installed.
brew install s2-streamstore/s2/s2
The binary should be installed as s2.
2

Persist your access token

s2 config set access_token YOUR_ACCESS_TOKEN
3

Create a new basin

Basin names must be globally unique. Try creating a basin with your GitHub handle, something like username-first-basin.
A basin name must be between 8 and 48 characters long and comprise lowercase letters, numbers and hyphens. It cannot begin or end with a hyphen.
export BASIN="YOUR_BASIN_NAME"
s2 create-basin ${BASIN}
Let’s double-check that the new basin is active. You should see its name in the list with an active status:
s2 list-basins
4

Grab your popcorn!

Nothing better than Star Wars to give us a good sense 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://${BASIN}/starwars
Some of you may have watched the movie in ASCII over telnet from towel.blinkenlights.nl!We will do the same, except we will “append” the movie to our starwars stream while we also tail it.Start by creating a read session like so:
s2 read s2://${BASIN}/starwars 2> /dev/null
Open another terminal and start an append session:
export BASIN="YOUR_BASIN_NAME" # Set the basin name for new terminal
nc starwars.s2.dev 23 | s2 append s2://${BASIN}/starwars
Go back to the previous terminal with the read session to enjoy the movie:

​
What You Just Used

You just created a basin, wrote to a stream, and moved records with appends and reads.

Explore S2 concepts

Start with records, then follow the model through streams, basins, appends, and reads.

Try more demos

Explore the playground, resumable AI chat, live sandbox logs, and collaborative editing.