Browse samples

nRF Connect for VS Code

tags
nRF Connect for VS Code

Use this action when you want to test a sample out of the box for an nRF Connect SDK version installed on your machine.

Note

If you have multiple SDK versions installed, the extension will ask you to select the SDK version to copy the sample from.

You can search for a specific sample by typing its name into the search field. The extension will run a fuzzy search on sample names and paths based on your input.

Sample browser

Each entry features buttons for opening the sample's source directory, the application's documentation, or its path in the repository. You can use the documentation to check the sample requirements or steps for testing.

Caution

When opening a sample in the SDK using the Browse samples action, any changes you make to the sample code change your SDK installation. This can cause issues later if you want to change the SDK to a different version. Use the Create a new application workflow if you want to change the sample code.

When you have found the sample you want to use, click its name to open it in the Applications View in a new Visual Studio Code instance. You can also use the nrf-connect.defaultOpenAction setting to configure the default action to take.

Note

Some samples in the nRF Connect SDK are currently not designed to work out-of-tree. You may need to manually configure your sample to work correctly in the extension.