Quick Start

First install the rngo CLI with Homebrew:

brew install rngodev/tap/cli

Next sign up for rngo, go to the API keys page, create an API key and copy it. Then log into the CLI and enter the API key when prompted:

rngo login
> API Key: *************

Make a file called spec.yml and add this simulation spec to it:

seed: 1
entities:
  users:
    stream:
      type: object
      properties:
        id:
          type: id.integer
        name:
          type: person.name
  posts:
    stream:
      type: object
      properties:
        id:
          type: id.integer
        title:
          enum:
            - Lorem Ipsum
            - Dolor Sit Amet
            - Sed Mattis Eu Erat
        authorId:
          type: function
          expression: user.id
          variables:
            user:
              type: reference
              entity: users

Now run the simulation like this:

rngo sim --spec spec.yml --stdout

This will output data that looks something like this:

{"entity":"users","offset":683878,"value":{"id": 1, "name": "Alice Jones"}}
{"entity":"users","offset":729698,"value":{"id": 2, "name": "Bob Hyland"}}
{"entity":"posts","offset":1036600,"value":{"id": 1, "title": "Lorem Impsum"},"authorId":1}

Next Steps

Now that you know the basics, go to Application Setup to learn how to integerate rngo into your application.