Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
i-am-shodan committed Jun 30, 2023
1 parent f24a335 commit e3551b9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Seahaven
Seahaven is a command-line tool written in C# that generates internally consistent test data. This is useful if you are trying to create environments that humans will interact with and that need to interact with or data that needs to pass a sanity check. Unlike other tools like Bogus exist that can generate lots of test data but this data often based firmly in fictional. Seahaven utilizes a combination of GPT models hosted on either Azure or OpenAI as well as bogus to ensure the generated data is not only realistic but also contextually meaningful.
Seahaven is a command-line tool written in C# that generates internally consistent test data. This is useful if you are trying to create environments that humans will interact with and require data that needs to pass a human sanity check. Other tools, like Bogus, exist that can generate lots of test data but this data often based firmly in fictional. Seahaven utilizes a combination of GPT models hosted on either Azure or OpenAI as well as Bogus to ensure the generated data is not only realistic but also contextually meaningful.

The name of the project, pays homage to the town featured in the film "The Truman Show." Just like the meticulously crafted world in the movie, Seahaven aims to generate test data that mirrors the authenticity and coherence found in a real human environment. By harnessing the power of GPT models, Seahaven brings forth data that feels as genuine and interconnected as the fabricated reality Truman unwittingly inhabited.
The name of the project, pays homage to the town featured in the film "The Truman Show." Just like the meticulously crafted world in the movie, Seahaven aims to generate test data that mirrors the authenticity and coherence found in a real human environment. By harnessing the power of GPT models, Seahaven creates h data that feels as genuine and interconnected as the fabricated reality Truman unwittingly inhabited.

## Features
* Generate test data that is internally consistent and human-readable.
Expand All @@ -11,7 +11,7 @@ The name of the project, pays homage to the town featured in the film "The Truma

## Getting Started
### Getting Seahaven
Go to the releases page and download the latest release. It doesn't matter if you don't have the dotnet SDK installed.
Go to the releases page and download the latest release for your OS. It doesn't matter if you don't have the dotnet installed.

### Usage
To generate test data using Seahaven, follow these steps:
Expand All @@ -22,7 +22,7 @@ To generate test data using Seahaven, follow these steps:

### Seahaven commands

The following commands can either be used at the command like directly or perhaps more usefully combined into a script. Here is an example script.
The following commands can either be used at the command like directly or perhaps more usefully combined into a script. Here is an example script, you can run it with the `script file=<THEFILE>` command.

```
# Your Azure/OpenAI model. You need to get this from the OpenAI dev page or the Azure portal
Expand Down Expand Up @@ -71,10 +71,10 @@ show company

To get a full list of commands use
```
Seahaven.exe -h
Seahaven -h
```

### Building Seahaven
### Building Seahaven from source
#### Prerequisites
To run Seahaven, you need to have the following installed on your system:
* .NET 6 SDK
Expand Down

0 comments on commit e3551b9

Please sign in to comment.