Skip to content

Commit 3933ac6

Browse files
committed
update doc
1 parent 7eca8f5 commit 3933ac6

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/features.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,25 @@ You can also select specific list of models to run the health check on by provid
4242
4343
datapilot dbt project-health --manifest-path ./target/manifest.json --select "path:dir1 path:dir2 model1 model2"
4444
45-
This will run the health check on all the models in the 'dir1' and 'dir2' directory. It will also run the health check on the 'model1' and 'model2' models.
45+
This will run the health check on all the models in the 'dir1' and 'dir2' directory, as well as the 'model1' and 'model2' models.
4646
As of now, the '--select' flag only supports filtering based on model path and model name. We will add support for other filters and make it compatible
47-
with the dbt comands soon.
47+
with the dbt commands soon.
48+
49+
3. **Configuration**:
50+
You can provide configuration in two ways:
51+
52+
a. Using a local config file:
53+
.. code-block:: shell
54+
55+
datapilot dbt project-health --manifest-path ./target/manifest.json --config-path ./path/to/config.yml
56+
57+
b. Using a named config from the API:
58+
.. code-block:: shell
59+
60+
datapilot dbt project-health --manifest-path ./target/manifest.json --config-name "my-config" --token "YOUR_API_TOKEN" --instance-name "YOUR_INSTANCE"
61+
62+
The ``--config-name`` option allows you to use a configuration stored in the Altimate API. When using this option, you must also provide:
63+
- ``--token``: Your API token for authentication
64+
- ``--instance-name``: Your tenant ID
65+
66+
If both ``--config-path`` and ``--config-name`` are provided, the local config file (``--config-path``) takes precedence.

0 commit comments

Comments
 (0)