# Introduction

{% hint style="warning" %}
&#x20;**dbt-sugar is very much under active development. Development happens on** [bitpicky/dbt-sugar](https://github.com/bitpicky/dbt-sugar). **We absolutely would welcome any help from feature requests, discussion in issues, help with database connector testing to actual code changes! 🤗.**\
\
Join the community on our [Discord](https://discord.com/invite/cQB49ejbCA).
{% endhint %}

## What is dbt-sugar?

dbt-sugar is a command-line interface tool that allows users of [dbt](https://www.getdbt.com/) to perform tasks such as **adding column and model documentation, enforce test coverage and tags (more to come)** directly from the CLI across a variety of dbt projects. Check out the [project roadmap ](https://github.com/bitpicky/dbt-sugar/blob/main/ROADMAP.md)if you want to know what is coming!

### Here's the tool in action

![dbt-sugar in action](/files/-MY1WNlbHHZwOR7RxdTL)

### Overview of Current Features

#### [Documentation Task](/dbt-sugar/commands/dbt-sugar-doc.md)

* document a model's description
* document columns of a model (and propagate description across fields that are identically named, we call this "homogenise" and it is the main reason behind why we built dbt-sugar,
* add common `dbt` builtin tests such as `unique` or `not_null`,
* add tags

#### [Audit Task](/dbt-sugar/commands/dbt-sugar-audit.md)

* get a model or project level summary of the number of columns that are documented and tested.

#### [Bootstrap Task](/dbt-sugar/commands/dbt-sugar-bootstrap.md)

* Do you have very few models documented? Want to quickly generate `schema.yaml` files for all of your models and have it pre-populated by placeholders or already documented columns that share names across your projects. Kick it off with the bootstrap task

### What has recently changed?

We maintain and keep our CHANGELOG up to date on the [GitHub repository](https://github.com/bitpicky/dbt-sugar/). Head over [there](https://github.com/bitpicky/dbt-sugar/blob/main/CHANGELOG.md) if you want to see all the changes since the last release.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bitpicky.gitbook.io/dbt-sugar/undefined.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
