Skip to content

docs: add step-by-step setup for GitHub Copilot in VS Code - #242

Draft
Rubén (rublaman) wants to merge 2 commits into
microsoft:mainfrom
rublaman:feat/vscode-copilot-support
Draft

Rubén (rublaman) wants to merge 2 commits into
microsoft:mainfrom
rublaman:feat/vscode-copilot-support

Conversation

@rublaman

Copy link
Copy Markdown

The Copilot installation instructions currently cover the standalone CLI. This PR adds a
Windows guide for GitHub Copilot Chat in VS Code with Copilot selected as the session target.
The existing Copilot CLI documentation stays unchanged, and both READMEs link to the new guide.

The walkthrough covers Copilot setup, downloading TokenEconomizer, installing and activating
project hooks, checking a session, and updating or removing the configuration. It includes
troubleshooting and explains which features have been checked in the editor. This setup
requires neither GitHub CLI nor standalone Copilot CLI; model calls that depend on the CLI
and unverified tool pruning remain disabled.

Testing in VS Code also exposed a parser bug: Copilot metadata containing "tool_use" caused
the log to be read as a Claude transcript, returning no tool calls. The fix checks for actual
Claude tool blocks before falling back to Copilot events. A regression test covers successful
and failed calls, tool counts, and working directories.

Validation:

  • The regression failed before the fix, and 159 focused trace, hook, and micro-skill tests
    passed afterward. Following the rebase onto upstream/main, the full package suite finished
    with 1168 passed and 35 skipped in 263.49 seconds on Windows. Skips cover optional integrations
    and platform requirements, including symlinks and POSIX shell tests. The earlier validation
    environment used Windows 11, Python 3.13.17, pytest 9.2.0, and PowerShell 7.6.10.
    The full CI matrix was not run locally.
  • Before the rebase, three live sessions ran in VS Code 1.146.0 using the Copilot target and Copilot Fusion with
    free account access. The logs reported runtime 1.0.108-0 and model gpt-6-luna. Neither gh
    nor copilot was available on the hooks' PATH. An isolated observer captured all six lifecycle
    event types, successful and failed reads, and an edit. The fixed parser recovered the first
    session's four calls and the final session's single read.
  • The model returned a manually seeded context marker verbatim in a new session, without the
    marker appearing in the user prompt. Closing the final test window delivered SessionEnd and
    triggered automatic folding. The first end-hook observer did not finish, so that session
    was folded manually. Usage totals became available after session.shutdown.
  • The guide's setup and status commands ran in an isolated path containing spaces, an
    apostrophe, and a non-ASCII character. They generated six hooks, and a synthetic SessionStart
    completed without a TokenEconomizer error log. The marketplace bundle built successfully;
    local guide links and git diff --check also passed.
  • The earlier python -m pytest tests experiments/tests run left 36 benchmark failures on
    Windows. Of 46 cases retried outside the sandbox because of Git Bash restrictions, 9 passed
    and 1 skipped for Windows symlink privileges. All remaining failures were in the benchmark
    suite, involving os.getuid, signal.SIGHUP, path assertions, or shell lookup assumptions.
    Putting Git Bash first on PATH did not resolve every subprocess lookup. Benchmark code is unchanged.

Natural fact learning, resumed sessions, packaged plugin discovery and installation, tool
pruning, and editor-only model calls still need validation. The context-marker check verifies
injection only, and these runs did not measure token savings. The supported-version table
remains unchanged.

@microsoft-github-policy-service

Copy link
Copy Markdown

Rubén (@rublaman) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant