Extension API

    This documentation describes:

    • How to build, run, debug, test and publish an extension
    • How to take advantage of VS Code’s rich Extension API
    • Where to find and code samples to help get you started

    Code samples are available at .

    Here are some examples of what you can achieve with the Extension API:

    If you’d like to have a more comprehensive overview of the Extension API, refer to the Extension Capabilities Overview page. also includes a list of code samples and guides that illustrate various Extension API usage.

    • Get Started teaches fundamental concepts for building extensions with the Hello World sample.
    • Extension Capabilities dissects VS Code’s vast API into smaller categories and points you to more detailed topics.
    • Extension Guides includes guides and code samples that explain specific usages of VS Code Extension API.
    • Testing and Publishing includes in-depth guides on various extension development topics, such as and publishing extensions.
    • Advanced Topics explains advanced concepts such as , Supporting Remote Development and GitHub Codespaces, and .
    • References contains exhaustive references for the VS Code API, , and many other topics.

    VS Code updates on a monthly cadence, and that applies to the Extension API as well. New features and APIs become available every month to increase the power and scope of VS Code extensions.

    To stay current with the Extension API, you can review the monthly release notes, which have dedicated sections covering:

    • Extension authoring - Learn what new extension APIs are available in the latest release.
    • - Review and give feedback on upcoming proposed APIs.
    • Stack Overflow: There are tagged , and over half of them already have answers. Search for your issue, ask questions, or help your fellow developers by answering VS Code extension development questions!
    • Gitter Channel and : Public chatroom for extension developers. Some VS Code team members chime in conversations.

    To provide feedback on the documentation, create new issues at Microsoft/vscode-docs. If you have extension questions that you cannot find an answer for, or issues with the VS Code Extension API, please open new issues at .