Skip to content

Commit 1221911

Browse files
committed
docs: [v0.9.4-bot] absolute dbt path, telemetry disclosure, #1052 link, duckdb-cli
Batches four correctness fixes to user-facing surfaces flagged by CodeRabbit + cubic: **B3 — onboard-connect.txt:195** (both bots): The venv fallback told users to paste `~/.venvs/dbt/bin/dbt`, but option-1's validation runs `test -x '<path>'` — single-quoted, so tilde never expands. The executable check would fail and the user would loop back to "paste again". Now instructs the ABSOLUTE path (with platform-specific examples) and explicitly notes the tilde-doesn't-expand constraint. **B4 — quickstart-new.md:44** (cubic, confidence 10): The scan disclosure claimed "no credentials sent, nothing leaves your computer" which is only partially true — a scan emits an anonymous environment summary (dbt-detected, warehouse-configured, etc.) to Application Insights if telemetry is enabled. Reworded to be accurate: no credentials, no schema/model/query content, but the environment summary may ride telemetry. Points at `OPENCODE_DISABLE_TELEMETRY=1` for strictly-offline scans. **B5 — filesystem.ts:286** (both bots): Docstring linked to the generic `/issues` listing instead of the specific tracking issue. Changed to `/issues/1052` so a future reader can find the migration work item without a search. **B10 — jaffle-shop README:55** (CodeRabbit): `pip install dbt-duckdb` installs only the dbt adapter — the `duckdb target/... -c 'select ...'` line at the bottom of the block uses the standalone `duckdb` CLI which comes from a separate `duckdb-cli` PyPI package. Added `duckdb-cli` to the install line with a comment explaining why both are needed.
1 parent f9581d9 commit 1221911

4 files changed

Lines changed: 11 additions & 5 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ altimate
4141

4242
## Step 2.5: First-run scan (optional)
4343

44-
Immediately after model setup, a **"Scan your environment?"** Yes/No dialog appears. Say **Yes** and altimate-code reads local config files (no credentials sent, nothing leaves your computer) and routes you into one of four branches:
44+
Immediately after model setup, a **"Scan your environment?"** Yes/No dialog appears. Say **Yes** and altimate-code reads local config files (`.dbt/profiles.yml`, `dbt_project.yml`, `.git/config`) — no credentials are read or sent, and no schema, model contents, or queries leave your computer. An anonymous environment summary (e.g. "dbt project detected, no warehouse configured") may be included in the standard telemetry stream if telemetry is enabled; disable via `OPENCODE_DISABLE_TELEMETRY=1` or the [telemetry docs](../usage/telemetry.md) if you want a strictly-offline scan. The scan then routes you into one of four branches:
4545

4646
- **Found a warehouse** → offers to add + verify each connection, then index its schema.
4747
- **Found dbt project, no warehouse** → asks which warehouse it runs against and walks you through `warehouse_add`.

‎packages/opencode/sample-projects/jaffle-shop-duckdb/README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ do). Every option is wired to a real workflow:
4747
activation menu, no LLM in the loop. You can drive dbt yourself:
4848

4949
```bash
50-
pip install dbt-duckdb # or `pipx install dbt-duckdb` if you hit PEP 668
50+
# dbt-duckdb ships the dbt adapter; duckdb-cli ships the standalone `duckdb`
51+
# binary the query line at the bottom uses. Two distinct PyPI packages — if you
52+
# skip duckdb-cli, `dbt build` still works but `duckdb target/...` won't.
53+
pip install dbt-duckdb duckdb-cli # or `pipx install dbt-duckdb duckdb-cli` if you hit PEP 668
5154
cd ~/altimate-sample-dbt # wherever you materialized the sample
5255
dbt seed # load the CSVs into DuckDB
5356
dbt build # run models + tests

‎packages/opencode/src/command/template/onboard-connect.txt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,10 @@ moment, not another menu):
192192
• `pipx install dbt-duckdb` (isolated per-tool venv, recommended)
193193
• `uv tool install dbt-duckdb` (if you already have `uv`)
194194
• `python3 -m venv ~/.venvs/dbt && ~/.venvs/dbt/bin/pip install dbt-duckdb`
195-
then paste `~/.venvs/dbt/bin/dbt` via option 1 above.
195+
then paste the ABSOLUTE path (e.g. `/Users/you/.venvs/dbt/bin/dbt`
196+
or `/home/you/.venvs/dbt/bin/dbt` — run `echo ~/.venvs/dbt/bin/dbt`
197+
in your shell to get it) via option 1 above. Tilde (`~`) does NOT
198+
expand inside the single-quoted validation below.
196199

197200
If the user pastes a path (option 1), do NOT interpolate the pasted
198201
string into a shell pipeline verbatim — a paste like `; rm -rf ~` would

‎packages/opencode/src/util/filesystem.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -283,8 +283,8 @@ export namespace Filesystem {
283283
* tmp-write-rename pattern is duplicated in `packages/tui/src/util/persistence.ts`,
284284
* `packages/opencode/src/memory/store.ts`, and
285285
* `packages/opencode/src/altimate/observability/tracing.ts` — see
286-
* https://github.com/AltimateAI/altimate-code/issues for the tracking issue
287-
* to migrate them (Tech Lead flagged the promise-vs-reality mismatch
286+
* https://github.com/AltimateAI/altimate-code/issues/1052 for the tracking
287+
* issue to migrate them (Tech Lead flagged the promise-vs-reality mismatch
288288
* during v0.9.4 release review; this docstring used to claim the
289289
* migration was done).
290290
*

0 commit comments

Comments
 (0)