esp-idf/docs/en/get-started/vscode-setup.rst

********************************
Getting Started with VS Code IDE
********************************

:link_to_translation:`zh_CN:[中文]`

We have official support for Visual Studio Code and we aim to provide complete end-to-end support for all actions related to ESP-IDF: namely build, flash, monitor, debug, tracing, core-dump, System Trace Viewer, etc.

Quick Install Guide
===================

The recommended way to install the ESP-IDF Visual Studio Code Extension is by downloading it from `VS Code Marketplace <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ or following `Quick Installation Guide <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_.

Review the `tutorials <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/toc.md>`_ for the ESP-IDF Visual Studio Code Extension to learn how to use all of the features.

Supported Features
==================

* **Setup**, will help you to quickly install ESP-IDF and its relevant toolchain with just a few clicks.
* **Build**, with one-click build and multi-target build, you can easily build and deploy your applications.
* **Flash**, with both UART and JTAG flash out-of-the-box.
* **Monitoring**, comes with a built-in terminal, you can trigger IDF Monitor Commands from within VS Code as you are used to in traditional terminals.
* **Debugging**, with out-of-the-box hardware `debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`_.
* **GUI Menu Config**, provides a simplified UI for configuring your chip.
* **App & Heap Tracing**, provides support for collecting traces from your application, and a simplified UI for analyzing them.
* **System View Tracing Viewer**, aims to read and display the *.svdat* files into the trace UI (we also support multiple core tracing views).
* **IDF Size Analysis Overview** presents a UI for binary size analysis.
* **Rainmaker Cloud**, inbuilt Rainmaker Cloud support where you can edit/read the state of your connected IoT devices easily. For more information see the `ESP Rainmaker <https://rainmaker.espressif.com/>`_ page.
* **Code Coverage**, inbuilt code coverage support with color highlights showing which lines have been covered. The HTML report renders directly inside the IDE.

Bugs & Feature Requests
=======================

If you face an issue with certain feature of VS Code or VS Code in general we recommend you ask your question in the `forum <https://esp32.com/viewforum.php?f=40>`_, or open a `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.

We also welcome new feature requests. Most of the features we have today are a result of people asking for them to be implemented. To improve certain aspects of the extension, `raise your feature request on GitHub <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.
VSCode Extension Setup Guide 2020-09-01 12:07:31 -04:00			`********************************`
			`Getting Started with VS Code IDE`
			`********************************`

Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync 2020-11-25 01:45:26 -05:00			:link_to_translation:`zh_CN:[中文]`
VSCode Extension Setup Guide 2020-09-01 12:07:31 -04:00
Update vscode-setup.rst Improved formatting and grammar, fixed links so that they render correctly Update docs/en/get-started/vscode-setup.rst Typo Co-authored-by: Krzysztof <krzychb@users.noreply.github.com> fixes review comments (links, features list) 2022-02-19 14:52:07 -05:00			`We have official support for Visual Studio Code and we aim to provide complete end-to-end support for all actions related to ESP-IDF: namely build, flash, monitor, debug, tracing, core-dump, System Trace Viewer, etc.`
VSCode Extension Setup Guide 2020-09-01 12:07:31 -04:00
			`Quick Install Guide`
			`===================`

Update vscode-setup.rst Improved formatting and grammar, fixed links so that they render correctly Update docs/en/get-started/vscode-setup.rst Typo Co-authored-by: Krzysztof <krzychb@users.noreply.github.com> fixes review comments (links, features list) 2022-02-19 14:52:07 -05:00			The recommended way to install the ESP-IDF Visual Studio Code Extension is by downloading it from `VS Code Marketplace <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ or following `Quick Installation Guide <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_.
docs: Fix vscode extension setup links 2021-04-23 08:45:24 -04:00
Update vscode-setup.rst Improved formatting and grammar, fixed links so that they render correctly Update docs/en/get-started/vscode-setup.rst Typo Co-authored-by: Krzysztof <krzychb@users.noreply.github.com> fixes review comments (links, features list) 2022-02-19 14:52:07 -05:00			Review the `tutorials <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/toc.md>`_ for the ESP-IDF Visual Studio Code Extension to learn how to use all of the features.
VSCode Extension Setup Guide 2020-09-01 12:07:31 -04:00
			`Supported Features`
			`==================`

Update vscode-setup.rst Improved formatting and grammar, fixed links so that they render correctly Update docs/en/get-started/vscode-setup.rst Typo Co-authored-by: Krzysztof <krzychb@users.noreply.github.com> fixes review comments (links, features list) 2022-02-19 14:52:07 -05:00			`* Setup, will help you to quickly install ESP-IDF and its relevant toolchain with just a few clicks.`
			`* Build, with one-click build and multi-target build, you can easily build and deploy your applications.`
			`* Flash, with both UART and JTAG flash out-of-the-box.`
			`* Monitoring, comes with a built-in terminal, you can trigger IDF Monitor Commands from within VS Code as you are used to in traditional terminals.`
docs: update CN translation for vscode-setup 2022-03-09 03:42:29 -05:00			* Debugging, with out-of-the-box hardware `debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`_.
Update vscode-setup.rst Improved formatting and grammar, fixed links so that they render correctly Update docs/en/get-started/vscode-setup.rst Typo Co-authored-by: Krzysztof <krzychb@users.noreply.github.com> fixes review comments (links, features list) 2022-02-19 14:52:07 -05:00			`* GUI Menu Config, provides a simplified UI for configuring your chip.`
			`* App & Heap Tracing, provides support for collecting traces from your application, and a simplified UI for analyzing them.`
			`* System View Tracing Viewer, aims to read and display the .svdat files into the trace UI (we also support multiple core tracing views).`
			`* IDF Size Analysis Overview presents a UI for binary size analysis.`
			* Rainmaker Cloud, inbuilt Rainmaker Cloud support where you can edit/read the state of your connected IoT devices easily. For more information see the `ESP Rainmaker <https://rainmaker.espressif.com/>`_ page.
docs: fix link to VS Code debugging 2022-02-24 05:01:52 -05:00			`* Code Coverage, inbuilt code coverage support with color highlights showing which lines have been covered. The HTML report renders directly inside the IDE.`
VSCode Extension Setup Guide 2020-09-01 12:07:31 -04:00
			`Bugs & Feature Requests`
			`=======================`

docs: update redirected links 2022-04-28 02:34:20 -04:00			If you face an issue with certain feature of VS Code or VS Code in general we recommend you ask your question in the `forum <https://esp32.com/viewforum.php?f=40>`_, or open a `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.
VSCode Extension Setup Guide 2020-09-01 12:07:31 -04:00
Update vscode-setup.rst Improved formatting and grammar, fixed links so that they render correctly Update docs/en/get-started/vscode-setup.rst Typo Co-authored-by: Krzysztof <krzychb@users.noreply.github.com> fixes review comments (links, features list) 2022-02-19 14:52:07 -05:00			We also welcome new feature requests. Most of the features we have today are a result of people asking for them to be implemented. To improve certain aspects of the extension, `raise your feature request on GitHub <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.