synthtraffic Get started
Docs menu

Getting started

Install Quickstart Overview

Build a scenario

Scenario file Generators vars and const Time and pace Defaults Relationships Schedules Instances Lifecycle Collections Connections Delivery behavior

Connectors

Kafka PostgreSQL HTTP File S3 GCS Azure Blob

Expressions

Syntax IDs and sequences Random Faker Selection Modifiers Math Logic Collections ref and previous Time functions Strings and env Easing

CLI

sample run studio

Studio

Overview Workspace and editor Sample and timeline Run and Stop

Reference

Diagnostics Faker data

CLI

studio

Use studio to edit, sample, and run scenarios in the local Synthstudio UI.

Usage

synthtraffic studio [flags]

studio accepts no positional arguments. Choose the workspace with --folder:

synthtraffic studio --folder ./scenarios --port 8787

Flags

  • --folder <path> — set the workspace root used by Open, Save, and New (default: the current directory).
  • --port <port> — set the listen port (default 8787).
  • -h, --help — show command help without starting Studio.

What starts

On a normal host, Studio binds to 127.0.0.1, opens the default browser, and serves the UI at the selected port. Inside Docker it binds to 0.0.0.0 so a published port can reach it, and it does not try to open a browser.

Open, Save, and New stay inside --folder and work only with .yaml, .yml, and .json files. Ctrl+C stops the server.

Open Studio from another command

sample and run can open the same UI with --with-studio. When you set a non-default port, --port must appear with --with-studio:

synthtraffic sample scenario.yaml --events 10 --with-studio --port 8787
synthtraffic run scenario.yaml --stdout --with-studio --port 8787

studio requires a valid license. See Install.