kingwl
2e7cdddb89
# Conflicts: # .agents/notes/implemented/feature/2026-07-14-cross-family-fs-sandbox.i18n.yaml # .agents/notes/implemented/feature/2026-07-14-cross-family-fs-sandbox.md # .agents/notes/implemented/feature/2026-07-14-cross-family-fs-sandbox.zh.md # docs/capability-seams.md # docs/cordis-catalog/events.md # docs/cordis-catalog/services.md # docs/event-producer-consumer.md # docs/module-graph.md # docs/persistence-catalog.md # docs/rfc/INDEX.md # examples/acp-agent/README.md # examples/acp-agent/fs.cordis.snapshot.yml # examples/acp-agent/fs.cordis.yml # examples/acp-agent/tests/snapshots/escalation-approved/session.jsonl # examples/acp-agent/tests/snapshots/escalation-rejected/session.jsonl # examples/acp-agent/tests/snapshots/hook-cc-pretool-ask/session.jsonl # examples/acp-agent/tests/snapshots/permission-switching/session.jsonl # examples/acp-agent/tests/snapshots/workspace-context/system-prompt.expected.md # examples/acp-agent/tests/snapshots/workspace-context/tool-schemas.expected.json # examples/acp-agent/tests/snapshots/workspace-edit/system-prompt.expected.md # examples/acp-agent/tests/snapshots/workspace-edit/tool-schemas.expected.json # packages/bash/bash/src/index.ts # packages/bash/tool-bash/package.json # packages/bash/tool-bash/src/index.ts # packages/bash/tool-bash/tests/tools.spec.ts # packages/cordis/tool-cordis/src/api-catalog.ts # packages/fs/README.md # packages/fs/tool-fs/src/edit.ts # packages/fs/tool-fs/src/write.ts # packages/sandbox/README.md # pnpm-lock.yaml
65 lines
2.6 KiB
Markdown
65 lines
2.6 KiB
Markdown
<!-- Generated by scripts/gen-website-api.ts — do not edit by hand. Run `pnpm run gen-website-api` to regenerate. -->
|
|
|
|
# ctx.bashEnv
|
|
|
|
`BashEnvRegistry` — provided by `@deepseek-ai/dsh-tool-bash`.
|
|
|
|
Registry (`ctx.bashEnv`) for trusted, per-execution `DSH_*` variables. The namespace is rebuilt for every model bash call: ambient `DSH_*` values are discarded by the executor, then the registry's current snapshot is injected. Built-in shell facts remain owned by the registry itself while plugins can register additional, enumerable facts with effect-scoped disposal.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/bash/tool-bash/src/index.ts#L103)
|
|
|
|
### ctx.bashEnv.register(contributor)
|
|
|
|
```ts website-api
|
|
/**
|
|
* Register one environment contributor. Names and keys are unique; built-in
|
|
* keys are reserved. Registration is disposed with the calling plugin fiber.
|
|
* @param contributor - declared key ownership and per-execution resolver.
|
|
* @returns the disposer that unregisters the contribution.
|
|
*/
|
|
register(contributor: BashEnvContributor): () => void
|
|
```
|
|
|
|
Register one environment contributor. Names and keys are unique; built-in keys are reserved. Registration is disposed with the calling plugin fiber.
|
|
|
|
- `contributor` — declared key ownership and per-execution resolver.
|
|
|
|
**Returns** the disposer that unregisters the contribution.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/bash/tool-bash/src/index.ts#L124)
|
|
|
|
### ctx.bashEnv.collect(execution)
|
|
|
|
```ts website-api
|
|
/**
|
|
* Build the trusted `DSH_*` snapshot for one bash tool execution.
|
|
* @param execution - the current tool execution.
|
|
* @returns an immutable environment overlay containing built-ins and current contributions.
|
|
*/
|
|
collect(execution: ToolExecution): DshEnvironment
|
|
```
|
|
|
|
Build the trusted `DSH_*` snapshot for one bash tool execution.
|
|
|
|
- `execution` — the current tool execution.
|
|
|
|
**Returns** an immutable environment overlay containing built-ins and current contributions.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/bash/tool-bash/src/index.ts#L166)
|
|
|
|
### ctx.bashEnv.list()
|
|
|
|
```ts website-api
|
|
/**
|
|
* Enumerate plugin-contributed variables without executing their resolvers.
|
|
* @returns declarations sorted by environment variable name.
|
|
*/
|
|
list(): BashEnvVariableInfo[]
|
|
```
|
|
|
|
Enumerate plugin-contributed variables without executing their resolvers.
|
|
|
|
**Returns** declarations sorted by environment variable name.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/bash/tool-bash/src/index.ts#L198)
|