Clarify SDK architecture and in-process runtime transport
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
Open the root README architecture section and read docs/setup/in-process-runtime.md for the terminology and link target. Update the section to distinguish the Copilot agent runtime from the CLI, explain the default out-of-process JSON-RPC path and experimental in-process C ABI/FFI path, and confirm the documentation-only wording is accurate.
Written by the indexing model from the issue text.
Description
Description
The root README architecture section says that all SDKs communicate with the Copilot CLI server through JSON-RPC. That describes the default child-process transport, but it does not mention the experimental in-process transport now available across the supported SDKs.
The in-process transport loads the Rust runtime through its native C ABI and does not start a CLI child process. The current wording can therefore imply that the CLI server is the only supported architecture.
Suggested change
Update the root README architecture section to:
- distinguish the Copilot agent runtime from the Copilot CLI interface;
- describe the default out-of-process JSON-RPC path;
- mention the experimental in-process C ABI/FFI path;
- link to
docs/setup/in-process-runtime.mdfor details.
This is a documentation-only clarification. It does not change SDK behavior.
- Dominant language
- TypeScript
- Stars
- 10.5k
- Forks
- 1.5k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 106
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/copilot-sdk
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
github/copilot-sdk#2798 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
github/copilot-sdk#2793 ·
Maintainers usually reply within 1 day
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/copilot-sdk#2782 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
github/copilot-sdk#2781 ·
Maintainers usually reply within 1 day
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
github/copilot-sdk#2779 ·
Maintainers usually reply within 1 day
All issues in github/copilot-sdk
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
automated issue report
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
drizzle-team/drizzle-orm#6418 ·
Maintainers usually reply within 4 days
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
diegosouzapw/OmniRoute#15307 · 1 comment ·
Maintainers usually reply within 2 days
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
lingdojo/kana-dojo#31436 · 1 comment · 5 reactions ·
Maintainers usually reply within 1 day