scribe

KO | EN

gitlite — search

#python #css #html #javascript #flutter #ai #llm #deep-learning #php #react-native #telegram #ios

★ 37 Open GitHub ↗

Command line interface for translating natural language prompts into SQL queries using the OpenAI API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Scribe 📝

`scribe` is a command line interface for translating natural language prompts into SQL.
It makes use of the [OpenAI codex models](https://beta.openai.com/docs/models/codex) (via API) to execute translations.

The user is expected to supply a database connection to the `scribe` command, so that the underlying SQL database may be introspected to supply tables, views, column names and column types to the prompt context.

Additional examples can be supplied from a SQL file to improve the quality of the generations.

![Demo GIF](https://raw.githubusercontent.com/mergestat/scribe/main/docs/demo.gif)

## Usage

You will need to set the `OPENAI_API_KEY` environment variable.

```sh
scribe "all users with first name patrick" --connection "pg://postgres:password@localhost/?sslmode=disable"
SELECT * FROM users WHERE first_name = 'patrick'
```

The `--connection` flag is used to supply a connection string to the SQL database.
It can also be set with the `SCRIBE_CONNECTION` environment variable.

You may also supply **additional SQL examples** from a local file to improve the quality of translations.
This is not required, but can be valueable for supporting more complex query generation.
Use the `--examples` flag to point to a local SQL file, which could look something like this:

```sql
-- select all git commits in the last 30 days
SELECT * FROM git_commits WHERE author_when > (now() - '30 days'::interval)
```

## Installation

### Homebrew

```sh
brew install mergestat/scribe/scribe
```

## Roadmap
- Additional SQL database support (today only `postgres` is supported)
- Interactive "REPL" like terminal experience
- Option to execute queries on the underlying database and return results

scribe

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README