Start Building for Free
CircleCI.comAcademyBlogCommunitySupport

VS Code extension overview

1 month ago1 min read
Cloud
On This Page
  • Introduction
  • Install the VS Code extension

The CircleCI VS Code extension helps you avoid context-switching between VS Code and your browser.

Introduction

The CircleCI VS Code extension lets you visualize and manage CircleCI pipelines directly from your IDE, as well as providing contextual help when creating, modifying and editing CircleCI YAML config files.

The extension allows you to:

  • Authenticate and connect VS Code to CircleCI.

  • Browse and interact with your pipelines.

Available actions include:

  • View pipelines, workflows, jobs statuses

  • View test outputs

  • Download artifacts

  • Approve jobs

  • Re-run builds

  • Be alerted through notifications when your workflows change status or need your attention

  • Access in-file support when editing CircleCI YAML configuration files, including:

    • Syntax validation

    • Syntax highlighting

    • Go-to-definition and go-to-reference

    • On-hover documentation and usage hints

    • Autocompletion

Install the VS Code extension

For installation and setup instructions, see the VS Code marketplace page, or search for the extensions tab in the VS Code app.


Help make this document better

This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.

Need support?

Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.

You can also visit our support site to find support articles, community forums, and training resources.