Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
radbrt committed Mar 4, 2024
1 parent 3862b4e commit 9f7eadd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

An AI CLI utility for common tasks with dbt. Commands are intended to run inside a dbt project, and parses the dbt manifest to provide relevant context for the LLM.

Features include:
- Generate documentation for an existing dbt model, based on the upstream models and the model code.
- Generate Unit tests for a dbt model, given a description of what to test.
- Explain a dbt model.
- Interactively chat with a dbt model.
- Run SQLFluff and optionally rewrite a model for clarity.
- Change an existing model based on a description of desired changes.

## Get started

The library currently only works with OpenAI as backend. We hope to expand this, but for now you need an OpenAI API key at hand.
Expand Down
3 changes: 2 additions & 1 deletion dbtai/templates/prompts.py
Original file line number Diff line number Diff line change
Expand Up @@ -526,4 +526,5 @@
```
The output should be a JSON containing a key "code" with the dbt model code, and a key "explanation" with a string explaining the changes made.
"""
"""

0 comments on commit 9f7eadd

Please sign in to comment.