Workbench inspection
September 6, 2026 · View on GitHub
English | 中文
DeepSeekGUI's read-only adapter serves current filesystem and Git facts through the official Remote gateway. SessionQuery supplies the recorded cwd for live or cold Sessions; no model request or second Session store is involved.
The package README owns response fields, bounds, and failure semantics. Filesystem and Git remain the underlying capability owners. The Workbench separates current reads from annotated conversation history and cancels reads when the inspector closes.
Cordis API
Generated from source by scripts/gen-cordis-catalog.ts (verified fresh by pnpm run verify-cordis-catalog in doc-sync; regenerate with pnpm run gen-cordis-catalog) — the language sides differ only in locale-specific paired document paths. Signature blocks use a ts cordis-catalog fence and keep the original source JSDoc; dispatch modes are defined in the primer, and the framework-inherited ctx API lives in cordis-api/inherited.md.
ctx.workbenchInspector — WorkbenchInspector
Read-only Remote namespace; no Session events, model requests, or writes.
/**
* Read complete bounded text using provider-owned decoding and binary rejection.
* @param sessionId - Session whose recorded cwd anchors the read.
* @param path - File relative to the selected root.
* @param repository - Select the Session's Git root instead of cwd.
* @param signal - Request cancellation.
* @returns the file text; oversized or binary files fail explicitly.
*/
@Remote async text(sessionId: SessionId, path: string, repository: boolean, signal: AbortSignal): Promise<WorkbenchFileText>
/**
* Read the project memory file (`<folder>.memory.md` in the Session cwd)
* and whether the project has an AGENTS.md. A missing memory file is a
* normal state ("no memory yet"), not a failure.
* @param sessionId - Session whose recorded cwd anchors the read.
* @param signal - Request cancellation.
* @returns the cwd, the memory file name, its text or null, and the AGENTS.md presence.
*/
@Remote async memory(sessionId: SessionId, signal: AbortSignal): Promise<WorkbenchMemory>
/**
* Read current repository status without running a model or tool.
* @param sessionId - Session whose recorded cwd anchors the read.
* @param signal - Request cancellation.
* @returns canonical Git status and root.
*/
@Remote async status(sessionId: SessionId, signal: AbortSignal): Promise<WorkbenchRepository>
/**
* Read the current patch for one path or the complete selected scope.
* @param sessionId - Session whose recorded cwd anchors the read.
* @param scope - Index or unstaged changes.
* @param path - Repository-relative file; empty selects all changes.
* @param signal - Request cancellation.
* @returns the bounded provider diff; truncation is never silent.
*/
@Remote async diff(sessionId: SessionId, scope: DiffScope, path: string, signal: AbortSignal): Promise<DiffResult>
/**
* Repository-level facts for the Git and Worktree views in one read:
* status, configured remotes, the newest commits, and every registered
* work tree with its own changed paths. Nothing is written; a work tree
* whose status cannot be read reports no changed paths.
* @param sessionId - Session whose recorded cwd anchors the read.
* @param signal - Request cancellation.
* @returns the read-only repository overview.
*/
@Remote async overview(sessionId: SessionId, signal: AbortSignal): Promise<WorkbenchOverview>
Types: DiffResult · DiffScope · SessionId