README.zh.md 5.5 KB


description: "本次运行环境的不可变快照,记住每个值来自哪一层;供必须以不信任压平 process.env 的方式解析面向用户值的包使用。"

kind: "package-library"

@deepseek-ai/dsh-launch-environment

English | 中文

概述

使用 @deepseek-ai/dsh-launch-environment 解析启动时的环境值,无需信任压平的 process.env。它会冻结继承的进程值、调用目录的 .env 和 Harness 主目录的 .env,再按固定可信顺序返回胜出的值及其来源。调用方可以在敏感查找中排除某些层;无论之后顺序如何变化,被省略的层都不可达。快照不可变,但每一层仍会被复制到 process.env,因此它不隔离子进程。请把它作为库导入;不能从 cordis.yml 挂载它。

目录


使用本包

当各层并非同等可信时,通过快照而非 process.env 解析面向用户的值——例如调用方绝不能从项目目录取得的凭据覆盖值。

解析一个值

import { launchEnvironmentOf } from '@deepseek-ai/dsh-launch-environment'

declare const ctx: import('@deepseek-ai/cordis').Context
const endpoint = launchEnvironmentOf(ctx).get('DEEPSEEK_BASE_URL')?.value

get(name) 按可信度从高到低搜索所有层。getFrom(name, sources) 只搜索指定的层,不改变这一可信顺序——绝不能接受某一层的调用方不把它列进去,因此后续任何重新排序都无法让它回来。

launchedThroughSsh(snapshot) 仅在继承的进程层中存在非空 SSH_CONNECTIONSSH_TTY 时返回 true。Web 浏览器唤起、自适应目录选择器与 Open In 共用此判断;项目与用户 .env 中的值不作为 SSH 会话的依据。

各层的优先级

它是什么
继承的进程环境 启动 shell、CI 任务或容器传入的内容——本次运行的明确意图
<invocation cwd>/.env harness 被启动于其中的项目;产品信任它配置自己的 agent(智能体)
$DSH_HOME/.env 用户自己的机器级默认值

变量名按平台自身的规则匹配:POSIX 上精确匹配,Windows 上不区分大小写。在 Windows 上做大小写敏感的查找会选错层——shell 里的 deepseek_api_key 与项目 .env 里的 DEEPSEEK_API_KEY 对操作系统而言是同一个变量。

没有启动器引导这棵树时

当产品 CLI(命令行界面)引导了这棵树时,launchEnvironmentOf(ctx) 返回启动器的快照;否则返回只含继承环境的那一层。该回退并不削弱规则:SDK 宿主或裸 cordis.yml 从未发现过任何文件,因此它拥有的一切就是它被启动时的环境。


理解实现

实现细节——点击展开 快照建立在一个分离之上:启动器决定存在哪些文件,快照决定值如何排序。 ### 源码地图 | 文件 | 职责 | |---|---| | [`src/index.ts`](src/index.ts) | `createLaunchEnvironmentSnapshot`、`launchEnvironmentOf` 与 `ctx.launchEnvironment` 槽位 | | — | 不发布运行时不变式伴生入口;快照在任何 fiber 启动前即已冻结,并且本包不拥有任何事件流或可变运行时数据;单元测试会强制检查其查找与拒绝规则。 | ### 快照如何保持冻结 `createLaunchEnvironmentSnapshot` 在构造时复制每一层的值,因此之后对源对象的修改无法改变快照。无论构造顺序如何,查找都按规范信任顺序进行;在 Windows 上,名字在存储前折叠为大写,因此大小写变体无法拆分优先级。 ### 省略意味着什么 `getFrom` 按规范顺序过滤,绝不按调用方列表的顺序。省略一层就是拒绝:该值在该调用中不可达,这正是调用方在某个决策绝不能被某层影响时使用的机制。

进一步探索

当你需要构建快照的启动器或通过快照解析的消费方时,阅读以下页面。

  • boot 包——在任何配置项挂载之前填充 ctx.launchEnvironment 的启动器。
  • 凭据存储——针对快照各层解析已存储的凭据。
  • DeepSeek 提供方——通过启动环境读取提供方配置。

已知限制与延期工作

这些限制说明快照何时不是安全边界。它们是当前包约束,不是任务积压。

  • 快照不是子进程边界——每一层同样会被物化进 process.env,因此项目里的普通变量会按 dsh-subprocess 的清洗规则抵达子进程;产品启动器的 .env 约定 会在物化之前拒绝 bootstrap 变量。
  • 没有按工作区划分的层——项目层是调用目录,在启动时固定;之后在 Web UI 中选择的工作区不贡献任何内容,这是刻意的,因为跟随它等于让模型自己的工作区在会话中途改变 harness 环境。

开发备注

维护者的工作上下文——点击展开 无。