Skip to content

Instantly share code, notes, and snippets.

@dingp

dingp/Copilot setup in VSCode.md

Last active December 12, 2023 22:57
Show Gist options
  • Save dingp/bd56238f6706995d134ea98a3fb6ff3c to your computer and use it in GitHub Desktop.
Save dingp/bd56238f6706995d134ea98a3fb6ff3c to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Copilot setup in VSCode.md

GitHub Copilot Subscription

🔴 Please exercise caution with Copilot enabled in your editor. Avoid opening sensitive files (export-controlled code, files containing PII, etc). 🔴

Apply for GitHub Education Benefits

  • Log in to GitHub and add your lab/university email to your profile:

    • Click on your icon in the top right corner of the page and navigate to "Settings."
    • Select "Emails" in the "Access" section of the sidebar.
    • Add your lab/university email if it's not already listed.

  • Visit GitHub Education or use this link to apply for GitHub benefits:

    • Choose "Teacher" or "Student" status based on eligibility requirements.
      • Must have a GitHub account.
      • Be an educator, faculty member, or researcher at a recognized educational institution.
      • Provide documentation from your school demonstrating your current employment status.
    • Select your lab/university email in the following section.
    • Enter the school's name; national lab names are also acceptable.
    • Describe how you plan to use GitHub (e.g., hosting repositories for non-profit research, CI/CD, using GitHub Pages, GitHub projects, etc.).
    • Click "Continue" to proceed to the next page.
    • Upload or take a picture of your lab/university ID and click submit.
    • Within a few minutes, your application should be approved in the system.

Obtain GitHub Copilot Subscription

  • Return to your GitHub settings page and choose "Copilot" in the "Code, Planning, and Automation" section of the sidebar.
  • Click "Start your free trial" and you'll be directed to a page showing that you has received the Copilot subscription for free due to your academic status.

Setting up Copilot in VSCode

Refer to this link for the GitHub documentation on this topic. It provides clear and easy-to-follow instructions. Official guides for integrating Copilot with other IDEs or editors, such as "JetBrains," "Vim," etc., can be found on the GitHub documentation page. While Emacs is not officially supported, you can follow this guide for integration in Emacs.

In summary, follow these steps:

  • Install the GitHub Copilot plugin in VSCode.
  • The installation process will guide you through the GitHub login process.
  • Once installed, you'll see hint boxes in your coding space to help you understand how to use GitHub Copilot.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment