Skip to content

Commit

Permalink
fix: update readme (#3)
Browse files Browse the repository at this point in the history
* fix: update readme

* fix: generate docs
  • Loading branch information
suryaiyer95 authored Jan 29, 2024
1 parent 6d788e3 commit 5188fc1
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ Replace [path_to_manifest] and [path_to_catalog] with the actual paths to your d

The [--catalog-path] is an optional argument. If you don't specify a catalog path, the tool will skip some insights that require the catalog file.

#### Generating Manifest and Catalog Files for dbt Projects

1. Generate Manifest File (manifest.json). Open your dbt project's root directory in a terminal or command prompt. Run `dbt compile`. This command generates manifest.json in the target folder.

2. Generate Catalog File (catalog.json). Ensure you're in your dbt project's root directory. Run `dbt docs generate`. This connects to your database and creates catalog.json in the target folder.

Note: The catalog.json is optional for some operations but required for comprehensive project health checks. dbt docs generate requires an active database connection and may take longer for projects with many models.

### Checks

The following checks are available:

| Name | Type | Description | Files Required | Overrides |
Expand Down

0 comments on commit 5188fc1

Please sign in to comment.