Skip to content

Commit b4d6cff

Browse files
docs: the read-while-it-runs guidance covers every tool command
Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01YNQjkaiykbC1WtASw6Yegs
1 parent 3e54dba commit b4d6cff

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎docs/docs/usage/tool.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: "Call Altimate Code data tools from any shell, agent or CI job with
77

88
Expose the data tools -- warehouse, SQL, schema, lineage, impact, PII, data-diff, FinOps and dbt -- as plain commands. The local data tools use no model or API key, so Claude Code, Codex and CI jobs can call them directly. Linked workspace tools authenticate to Altimate and `workspace_execute` may use backend models.
99

10+
Read stdout while a `tool` command runs. These commands write all of their output before they exit, so a caller that waits for exit before reading can block forever on output larger than a pipe holds. A reader that closes the pipe early doesn't change the exit code. A write that fails, such as on a full disk, exits non-zero.
11+
1012
## List tools
1113

1214
```bash
@@ -45,8 +47,6 @@ echo '{"query":"select 1"}' | altimate-code tool run sql_execute --args -
4547

4648
Arguments are validated against the tool's schema. An unknown tool, invalid arguments or a failing tool exits non-zero.
4749

48-
Read stdout while the command runs. The command writes all of its output before it exits, so a caller that waits for it to exit before reading can block forever on output larger than a pipe holds. A reader that closes the pipe early doesn't change the exit code. A write that fails, such as on a full disk, exits non-zero.
49-
5050
Only the data tools are exposed. Coding tools (`bash`, `read`, `edit`, ...), `dbt_pr_review` (use `altimate-code review`), memory and training tools are not available here.
5151

5252
## Permissions

0 commit comments

Comments
 (0)