Skip to content

Commit 73d14f6

Browse files
anandgupta42claude
andcommitted
docs: use platform-neutral <home>/.dbt/ notation instead of Unix-specific ~/.dbt/
Replace hardcoded `~/.dbt/profiles.yml` with `<home>/.dbt/profiles.yml` across all 6 doc files. Add Windows path example in the warehouses config page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent d18c1b8 commit 73d14f6

6 files changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export OPENAI_API_KEY=your_key # OpenAI
4747
altimate /discover
4848
```
4949

50-
`/discover` auto-detects dbt projects, warehouse connections (from `profiles.yml` — checks `DBT_PROFILES_DIR`, project directory, then `~/.dbt/`; plus Docker and environment variables), and installed tools (dbt, sqlfluff, airflow, dagster, and more). Skip this and start building — you can always run it later.
50+
`/discover` auto-detects dbt projects, warehouse connections (from `profiles.yml` — checks `DBT_PROFILES_DIR`, project directory, then `<home>/.dbt/`; plus Docker and environment variables), and installed tools (dbt, sqlfluff, airflow, dagster, and more). Skip this and start building — you can always run it later.
5151

5252
> **Headless / scripted usage:** `altimate --yolo` auto-approves all permission prompts. Not recommended with live warehouse connections.
5353

docs/docs/configure/warehouses.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ When discovering dbt profiles, altimate checks the following locations **in prio
480480
| 1 | Explicit path | If you pass a `path` parameter to the `dbt_profiles` tool |
481481
| 2 | `DBT_PROFILES_DIR` env var | Standard dbt environment variable — set it to the directory containing your `profiles.yml` |
482482
| 3 | Project-local `profiles.yml` | A `profiles.yml` in your dbt project root (next to `dbt_project.yml`) |
483-
| 4 | `~/.dbt/profiles.yml` | The global default location |
483+
| 4 | `<home>/.dbt/profiles.yml` | The global default location (e.g., `~/.dbt/` on macOS/Linux, `%USERPROFILE%\.dbt\` on Windows) |
484484

485485
This means teams that keep `profiles.yml` in their project repo (a common pattern for CI/CD) will have it detected automatically — no extra configuration needed.
486486

@@ -489,6 +489,7 @@ This means teams that keep `profiles.yml` in their project repo (a common patter
489489
export DBT_PROFILES_DIR=/path/to/your/project
490490

491491
# Option 2: Just put profiles.yml next to dbt_project.yml
492+
# Copy from default location (macOS/Linux)
492493
cp ~/.dbt/profiles.yml ./profiles.yml
493494
altimate /discover
494495
```

docs/docs/data-engineering/tools/warehouse-tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ env_bigquery | bigquery | GOOGLE_APPLICATION_CREDENTIALS
5353
| **Git** | `git` commands (branch, remote) |
5454
| **dbt project** | Walks up directories for `dbt_project.yml`, reads name/profile |
5555
| **dbt manifest** | Parses `target/manifest.json` for model/source/test counts |
56-
| **dbt profiles** | Searches for `profiles.yml`: `DBT_PROFILES_DIR` env var → project root → `~/.dbt/profiles.yml` |
56+
| **dbt profiles** | Searches for `profiles.yml`: `DBT_PROFILES_DIR` env var → project root → `<home>/.dbt/profiles.yml` |
5757
| **Docker DBs** | Bridge call to discover running PostgreSQL/MySQL/MSSQL containers |
5858
| **Existing connections** | Bridge call to list already-configured warehouses |
5959
| **Environment variables** | Scans `process.env` for warehouse signals (see table below) |

docs/docs/getting-started/quickstart-new.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ altimate
3434

3535
### Option A: Auto-detect from dbt profiles
3636

37-
If you have a `profiles.yml` — either in `~/.dbt/`, in your project repo, or pointed to by `DBT_PROFILES_DIR`:
37+
If you have a `profiles.yml` — either in your home directory's `.dbt/` folder, in your project repo, or pointed to by `DBT_PROFILES_DIR`:
3838

3939
```bash
4040
/discover
4141
```
4242

43-
Altimate searches for `profiles.yml` in this order: `DBT_PROFILES_DIR` env var → project root (next to `dbt_project.yml`) → `~/.dbt/profiles.yml`. It reads your dbt profiles and creates warehouse connections automatically. You'll see output like:
43+
Altimate searches for `profiles.yml` in this order: `DBT_PROFILES_DIR` env var → project root (next to `dbt_project.yml`) → `<home>/.dbt/profiles.yml`. It reads your dbt profiles and creates warehouse connections automatically. You'll see output like:
4444

4545
```
4646
Found dbt project: jaffle_shop (dbt-snowflake)

docs/docs/getting-started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ You can also set a smaller model for lightweight tasks like summarization:
189189
altimate /discover
190190
```
191191

192-
Auto-detects your dbt projects, warehouse credentials from `profiles.yml` (checks `DBT_PROFILES_DIR`, then your project directory, then `~/.dbt/profiles.yml`), running Docker containers, and environment variables (`SNOWFLAKE_ACCOUNT`, `PGHOST`, `DATABASE_URL`, etc.).
192+
Auto-detects your dbt projects, warehouse credentials from `profiles.yml` (checks `DBT_PROFILES_DIR`, then your project directory, then the default `<home>/.dbt/profiles.yml`), running Docker containers, and environment variables (`SNOWFLAKE_ACCOUNT`, `PGHOST`, `DATABASE_URL`, etc.).
193193

194194
### Manual configuration
195195

docs/docs/reference/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ altimate --print-logs --log-level DEBUG
5555

5656
**Solutions:**
5757

58-
1. **If using dbt:** Run `/discover` — it automatically finds your `profiles.yml` from `DBT_PROFILES_DIR`, your project directory, or `~/.dbt/profiles.yml`. If your `profiles.yml` is in a custom location, set `export DBT_PROFILES_DIR=/path/to/dir`.
58+
1. **If using dbt:** Run `/discover` — it automatically finds your `profiles.yml` from `DBT_PROFILES_DIR`, your project directory, or `<home>/.dbt/profiles.yml`. If your `profiles.yml` is in a custom location, set `DBT_PROFILES_DIR` to the directory containing it.
5959
2. **If not using dbt:** Add a connection via the `warehouse_add` tool, `~/.altimate-code/connections.json`, or `ALTIMATE_CODE_CONN_*` env vars.
6060
3. Test connectivity: use the `warehouse_test` tool with your connection name.
6161
4. Check that the warehouse hostname and port are reachable

0 commit comments

Comments
 (0)