github / github/copilot-sdk

Add per-session env overrides for built-in shell tool child processes

Offen
#2,040 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement vs-code
Vorherrschende Sprache
Java
Sterne
10.5k
Forks
1.5k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
127

Beschreibung

Follow up to #1911. The `initScripts` half of that ask shipped through the runtime in github/copilot-agent-runtime#12710, but the per-session `env` part was deferred out of that PR.

Context: https://github.com/microsoft/vscode/issues/323164

`initScripts` covers the Python activation case since the host can materialize a shell-specific activation file and have the runtime source it before each command. An explicit env map is still worth having for hosts that just want to set or unset a few variables without generating script files, and without dealing with per-shell quoting.

Current wire shape:

```ts
export interface ShellOptions {
initProfile?: "none" | "non-interactive";
initScripts?: ShellInitScript[];
processFlags?: string[];
}
```

Add the `env` map from the original proposal:

```ts
export interface ShellOptions {
/** Env applied to built-in shell tool child processes. `null` unsets/removes. */
env?: Record;
}
```

The reason this was deferred is that the update semantics should be pinned down before the wire shape ships:

- Whether `session.rpc.options.update` with `shell.env` replaces the whole overlay or merges per key. Replace seems right: it stays idempotent and a host can revert a variable to the inherited value by omitting it. With merge there is no way to un-touch a variable once set.
- Precedence: overlay applied to the spawned process env first, `initScripts` sourced after, so scripts can override.
- `null` meaning remove-from-env vs revert-to-inherited.
- Whether the overlay persists across resume or the host re-sends it, matching how the rest of `shell` behaves today.

(generated by copilot)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by tracing the ShellOptions wire shape and session.rpc.options.update handling described in the issue. Review how shell and initScripts behave across updates and resume, then pin down replacement, precedence, null-removal, and persistence semantics; done means the env overlay is represented and applied consistently to built-in shell child processes.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
shell, typescript
Bereich
api, cli
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.