Getting Started

Get up and running with datagen in just a few minutes. This guide will walk you through installing datagen and generating your first dataset.

Prerequisites

Installation

Option 1: Install via Go

Check your $PATH, and choose a directory you would like to place the datagenc compiler in.

echo $PATH
/Users/username/go/bin:/opt/homebrew/bin:/opt/homebrew/sbin

Say, you wish to place the binary in /opt/homebrew/bin;

export GOBIN=/opt/homebrew/bin
go install github.com/ds-horizon/datagen/cmd/datagenc@latest

Verify installation

datagenc --help

Option 2: Install from Source

Clone the repository

git clone github.com/ds-horizon/datagen

Build the compiler

make build-compiler

For permanent access on Mac/Unix, add the binary to your path, or add the current directory to your path:

echo 'export PATH=$PATH:$(pwd)' >> ~/.bashrc  # for bash
echo 'export PATH=$PATH:$(pwd)' >> ~/.zshrc   # for zsh

For permanent access on Windows, add to your shell profile:

echo '$env:PATH += ";C:\path\to\datagen"' >> $PROFILE

Now, source the rc files or fire up a new terminal window for the changes to take effect.

Verify installation

datagenc --help

Your First Model

Let’s create a simple user model to generate some test data.

model users {
  fields {
    name() string
    age() int
  }

  gens {
    func name() {
      return "Arthur Dent"
    }

    func age() {
      return IntBetween(18, 65)
    }
  }
}

Generate Your First Data

Now let’s generate some data from this model:

datagenc gen users.dg

Output:

users{name:Arthur Dent age:42}