Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/725-receipt-paths-optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
"agent-bundle": patch
---

Document the `audiobook-curator` example's CLI migration accurately: since the `<tool>.cli.ts` projections replaced the `src/cli/` tree (#734), `inventory --report` and `convert --receipt` are optional, as they are on the tools, instead of required; a command run without one writes no report or receipt file, and exit codes, `--apply` gating, and error output are unchanged. (#738)
Document the `audiobook-curator` example's CLI migration accurately: since the `<tool>.cli.ts` projections replaced the `src/cli/` tree (#734), every `--report` and `--receipt` option (thirteen of the sixteen commands, `inventory --report` and `convert --receipt` among them) is optional, as it is on the tools, instead of required; a command run without one writes no report or receipt file, and exit codes, `--apply` gating, and error output are unchanged. (#738)
10 changes: 6 additions & 4 deletions examples/audiobook-curator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,12 @@ Suspense fallback, and byte for byte the `structuredContent` of the tool call.
`--report` and `--receipt` are optional on the command line exactly as they are
on the tool; a command that gets one still writes the receipt file
when it succeeds. This is a
behavior change from the retired `src/cli/` tree, where `inventory --report`
and `convert --receipt` were required: both commands now run without a receipt
path and write no report or receipt file, and their exit codes, `--apply` gating, and error
output are unchanged either way.
behavior change from the retired `src/cli/` tree, where every command that
took a report or receipt path — thirteen of the sixteen, `inventory --report`
and `convert --receipt` among them — required it: those commands now run
without the path and write no report or receipt file, and their exit codes,
`--apply` gating, and error output are unchanged either way. `inspect`,
`prepare`, and `shelf` never took one.

Each tool module declares its `inputSchema` as an inline zod literal, because
the argv projection is compiled statically from that literal; it is the only
Expand Down
7 changes: 4 additions & 3 deletions website/docs/en/examples/audiobook-curator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,10 @@ emits one result-schema-validated JSON value followed by a newline: the canonica
and byte for byte the `structuredContent` of the tool call. `--report` and `--receipt` are
optional on the command line exactly as they are on the tool; a command that gets one still
writes the receipt file when it succeeds. This is a behavior change from the retired `src/cli/` tree, where
`inventory --report` and `convert --receipt` were required: both commands now run without a
receipt path and write no report or receipt file, and their exit codes, `--apply` gating, and error output are
unchanged either way.
every command that took a report or receipt path — thirteen of the sixteen, `inventory --report`
and `convert --receipt` among them — required it: those commands now run without the path and
write no report or receipt file, and their exit codes, `--apply` gating, and error output are
unchanged either way. `inspect`, `prepare`, and `shelf` never took one.

## Working in the workspace

Expand Down
5 changes: 3 additions & 2 deletions website/docs/zh/examples/audiobook-curator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ description: '有声书策展器示例:一个由路由模块、请求上下文
并输出一个经结果 schema 校验的 JSON 值加一个换行:这是最终的规范 `Agent.Result` 值,绝不是 Markdown
表现,也绝不是中间的 Suspense 回退,并且与工具调用的 `structuredContent` 逐字节一致。`--report` 与
`--receipt` 在命令行上和在工具上一样是可选的;传入了的命令在成功时仍会写出收据文件。这相对于已移除的
`src/cli/` 树是一处行为变化:那里的 `inventory --report` 与 `convert --receipt` 是必填的;现在这两条命令
不带收据路径也能运行且不写报告或收据文件,而退出码、`--apply` 把关与错误输出在两种情况下都不变。
`src/cli/` 树是一处行为变化:那里每条接受报告或收据路径的命令(十六条中的十三条,包括 `inventory --report`
与 `convert --receipt`)都把它设为必填;现在这些命令不带该路径也能运行且不写报告或收据文件,而退出码、
`--apply` 把关与错误输出在两种情况下都不变。`inspect`、`prepare` 与 `shelf` 从来不接受这个参数。

## 在工作区中开发

Expand Down
Loading