After installing the Synth CLI, the next step is to create a workspace. Workspaces are directories in your filesystem that Synth uses to read your schemas from.
To create and initialise a workspace called
synth_workspace in your current working directory, run:
synth init creates a marker directory called
.synth in your present working directory. This marker
directory acts as simply an anchor to tell Synth that this is a workspace.
Next we need to create a namespace. Namespaces are collections of schema files which are allowed to refer to one
another. They are organized simply by creating directories in your workspace. Let's create a namespace
Finally, we need to add a collection to our namespace. Collections are JSON files which describe the "shape" of the data we want to generate. They follow the Synth schemas format.
To create a collection called "dummy" in our namespace, simply copy/paste the content of the following example in a file
The previous example snippet is an example of the Synth schema format. All the examples of the Synth schema in these documentation pages are tagged with a "Run" button that lets you preview Synth output data when you click it.
and you should see an output very close to the output of the above snippet.