Skip to content
A VS Code extension that displays your Netlify build statuses
TypeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
docs/assets
out
src
.gitignore
.vscodeignore
CHANGELOG.md
README.md
netlify.jpeg
package.json
tsconfig.json
tslint.json
vsc-extension-quickstart.md
yarn.lock

README.md

Netlify for VS Code

Unofficial Netlify extension for VS Code.

Features

  • Deploy status and errors inside VS Code.
  • 🌍 View latest production build with single click.
  • 👀 Deploy preview straight from branch in VS Code.
  • ⚡️ VS Code command palette integration.

Documentation

Video Overview

Status bar

The deployment monitor in the VS Code status bar should show one of the following states:

  • Site is being deployed
  • Site deploy was successful
  • Site is waiting to be built
  • Site deploy has failed

Command palette

You can run the following commands from the VS Code command palette:

  • Netlify: View latest deploy
  • Netlify: View production site

Settings

You can configure the extension straight from VS Code settings, by simply searching for Netlify. However, should you wish, you can also configure it straight from the settings.json file as follows:

{
  "netlify.site_id": "<site_name|api_id>",
  "netlify.api_token": "<personal_access_token>",
  "netlify.set_interval": "<number>"
}

These values are as follows:

netlify.site_id

The name of your site or api id can be used, you can find these details under Site detail. If you site name is my-site then you need to append .netlify.com so it will be my-site.netlify.com

netlify.api_token

The api_token is your Personal Access Token which can be found in User Settings, this will be used to authenticate private Netlify projects

netlify.set_interval

The default is 10000ms but you can set whatever polling interval you would like.

Feedback

If you love using this VS Code extension, please leave some feedback or rate it on the VS Code Marketplace it would be greatly appreciated.

If you have any ideas on how we can improve this project or maybe you found a bug, please let us know via a Github Issue

You can’t perform that action at this time.