pyro-mcp/docs/roadmap/llm-chat-ergonomics/3.7.0-handoff-shortcuts-and-file-input-sources.md
Thales Maciel 7a0620fc0c Add workspace handoff shortcuts and file-backed inputs
Remove the remaining shell glue from the canonical CLI workspace flows so users can hand off IDs and host-authored text files directly.

Add --id-only on workspace create and shell open, plus --text-file and --patch-file for workspace file write and patch apply, while keeping the underlying SDK, MCP, and backend behavior unchanged.

Update the top walkthroughs, contract docs, roadmap status, and use-case smoke runner to use the new shortcuts, and verify the milestone with uv lock, make check, make dist-check, focused CLI tests, and a real guest-backed smoke for create, file write, patch apply, and shell open/read.
2026-03-13 11:10:11 -03:00

1.6 KiB

3.7.0 Handoff Shortcuts And File Input Sources

Status: Done

Goal

Remove the last bits of shell plumbing from the canonical CLI workspace flows so they feel productized instead of hand-assembled.

Public API Changes

Planned additions:

  • pyro workspace create ... --id-only
  • pyro workspace shell open ... --id-only
  • pyro workspace file write WORKSPACE_ID PATH --text-file PATH
  • pyro workspace patch apply WORKSPACE_ID --patch-file PATH

Implementation Boundaries

  • keep existing --json, --text, and --patch stable
  • treat these additions as CLI-only shortcuts over already-structured behavior
  • make --text and --text-file mutually exclusive
  • make --patch and --patch-file mutually exclusive
  • read file-backed text and patch inputs as UTF-8 text
  • keep /workspace scoping and current patch semantics unchanged

Non-Goals

  • no new binary file-write story
  • no new SDK or MCP surface just to mirror CLI shorthand flags
  • no hidden patch normalization beyond the current patch-apply rules
  • no change to the stable workspace_id contract

Acceptance Scenarios

  • README, install docs, and first-run docs can create one workspace ID without python -c output parsing
  • a user can apply a patch from fix.patch without $(cat fix.patch) shell expansion
  • a user can write one text file from a host file directly, without shell-escaped inline text

Required Repo Updates

  • top-level workspace walkthroughs rewritten around the new shortcut flags
  • CLI help text updated so the shortest happy path is copy-paste friendly
  • at least one smoke scenario updated to use a file-backed patch input