Deepnote in VS Code, Cursor, Windsurf, and Antigravity
A powerful Visual Studio Code, Cursor, Windsurf, and Antigravity extension that brings Deepnote notebook capabilities directly into your favorite editor. Work with sleek AI notebooks featuring SQL blocks, database integrations, and reactive blocks - all within your IDE.

Run Deepnote locally inside your IDE and unlock the next generation of data workflows:
- Rich block types: Combine Python, Markdown, data visualizations, tables, and more — all in one place
- SQL blocks: Run SQL queries out of the box, no extensions needed
- Native database connections: Securely connect to Snowflake, BigQuery, Postgres, and 60+ other sources via VS Code’s encrypted SecretStorage API
- Init notebooks: Auto-run setup code (dependencies, env setup) before execution
- Smart requirements: Generate
requirements.txt automatically for reproducible runs
- Deepnote kernel: Fully
.ipynb compatible, tuned for modern data workflows
- Cloud collaboration: Switch between local VS Code and Deepnote Cloud to collaborate live on the same file with your team
Getting started
- Open the extensions tab and Search for Deepnote
- Or alternatively, press
Cmd+P or Ctrl+P to open the command palette.
- Type
ext install Deepnote.vscode-deepnote
- Press Enter
Or install from the VS Code Marketplace
Requirements
- Visual Studio Code 1.95.0 or higher
- Python 3.10 or higher (for running notebooks)
Opening your first Deepnote notebook
- Open a folder containing
.deepnote project files
- Look for the Deepnote icon in the Activity Bar (sidebar)
- Click on a notebook in the Deepnote Explorer to open it
- Select a Python kernel when prompted
- Start coding!
Usage
Command palette
Open the Command Palette (Cmd+Shift+P or Ctrl+Shift+P) and type Deepnote to see all available commands:
| Command |
Description |
Deepnote: Refresh Explorer |
Refresh the Deepnote project explorer |
Deepnote: Open Notebook |
Open a specific notebook from a Deepnote project |
Deepnote: Open File |
Open the raw .deepnote project file |
Deepnote: Reveal in Explorer |
Show active notebook information in the explorer |
Deepnote: Show Project Explorer |
Show the Deepnote sidebar and select the active notebook when available |
Deepnote: Manage Integrations |
Configure database connections and credentials |
Deepnote: New Project |
Create a new Deepnote project |
Deepnote: Import Notebook |
Import an existing notebook into your project |
Deepnote: Set API Token |
Save a Deepnote API token for syncing and publishing |
Deepnote: Clear API Token |
Remove the saved Deepnote API token |
Deepnote: Sync with Deepnote Cloud |
Sync a folder that is already synced with your Deepnote workspace |
Deepnote: Sync a New Folder with Deepnote Cloud… |
Download your Deepnote workspace into a folder and start syncing it |
Deepnote: Publish App… |
Publish a folder, such as an app's build output, as a Deepnote data app |
Deepnote: Preview App |
Preview a data app folder in the editor's built-in browser |
Notebook: Select Notebook Kernel |
Select or switch kernels within your notebook |
Notebook: Change Cell Language |
Change the language of the cell currently in focus |
Deepnote: Enable Snapshots |
Enable snapshot mode for the current workspace |
Syncing with Deepnote Cloud
To start, run Deepnote: Sync a New Folder with Deepnote Cloud… from the Command Palette or from the … menu of the Deepnote explorer, and choose a folder.
After that, run Deepnote: Sync with Deepnote Cloud, or click the sync button in the Deepnote explorer title bar. With one synced folder in your workspace, it syncs that folder. With several, it asks which one, listing the folder of the file you have open first. With none, it offers to sync a new folder.
- Sync uses
DEEPNOTE_TOKEN from a .env file in the synced folder, or the token saved with Deepnote: Set API Token.
- The first sync into a folder downloads every project of your Deepnote workspace, one folder per project, and creates
.deepnote-sync.json.
- Each sync pulls projects changed in Deepnote and pushes projects changed locally.
- Before overwriting changes that were not synced, sync asks, offering one replacement and "Skip":
- For a project changed both locally and in Deepnote, or a local folder that already exists with different content where sync downloads a project, it offers to replace the local files with the Deepnote version.
- For local edits that Deepnote rejects because the project changed there, it offers to replace the Deepnote version with the local files.
- "Skip" leaves both copies as they are, and the next sync asks about that project again.
- Unsaved notebooks must be saved before a sync starts.
- Sync works only in a trusted workspace, in the desktop app, for a folder inside the open workspace that neither contains nor is inside another synced folder.
- Sync does not create Deepnote projects. Local
.deepnote files that are not linked to a project are left as they are.
- Deleting a project folder or a notebook file locally does not delete it in Deepnote, and the next sync downloads it again.
Known limitations:
- Edits made in the folder while a sync runs can be overwritten.
- Saving a notebook after running cells writes its outputs into the file, so the next sync pushes that project.
- After a sync updates an open notebook, the editor can save the notebook again, and the next sync can then push that project or report a conflict for it.
- A folder reached through a symbolic link or junction is checked by its path in the workspace, not by its target, so a link into another synced folder is not refused.
Publishing apps
Run Deepnote: Publish App… from the Command Palette, or right-click a folder in the file explorer and choose Publish App…. It uploads the folder to a Deepnote data app project and publishes the app, then shows the app URL with "Open" and "Copy". People with access to the project can open a published app; there is no anonymous or link-only access.
- The folder is published as it is. Build your app first, then publish its build output folder, such as
dist/.
- Each file of the folder replaces the app file at the same path in Deepnote. Files you delete from the folder are not deleted in Deepnote and stay published; delete them in Deepnote.
- Only data app projects can be published to. When the folder is inside a synced project, the app goes to that project after one confirmation, and publishing fails if it is not a data app. Otherwise you choose one of your workspace's data apps, or "New Data App…" to create a data app project with the name you enter.
- The data app is remembered per folder, so publishing the folder again asks only for one confirmation, with "Change Settings…" to choose again.
- A data app calls Deepnote with a short-lived token scoped to the person viewing it, never your personal token.
- Publishing needs "Allow static file sharing in projects" turned on in the workspace settings.
- Publishing uses
DEEPNOTE_TOKEN from a .env file in a synced folder above the app folder, or else the token saved with Deepnote: Set API Token. A folder that contains a .env or .env.* file cannot be published, because every published file can be served to the app's viewers.
- Publishing into a synced folder does not start while a sync or another such publish is in progress.
- For a folder inside a synced project, when app files changed in Deepnote since the last sync or publish, publishing asks first. "Force" overwrites them in Deepnote. "Sync First" syncs the whole synced folder with the working files of every project, which downloads Deepnote's versions of the app files into the synced project's
.files/_deepnote_static folder, so you can merge them into your app and publish again. It also replaces the local copy of every working file that changed in Deepnote, so it is not offered for a folder that is in, or contains, a synced project's .files folder. A project with a working file over 100 MiB fails to sync this way. A folder outside a synced project overwrites app files changed in Deepnote without asking.
- Publishing needs a trusted workspace and the desktop app.
Previewing apps
Run Deepnote: Preview App from the Command Palette, or right-click a folder in the file explorer and choose Preview App, to see the app before you publish it. The page opens in the editor's built-in browser, or in your system browser when the editor has none. In recent versions of VS Code's integrated browser, previewing the same folder again reloads the page in the tab already showing it.
- The folder is served the way Deepnote serves a published app, from a local address. Edit a file and reload the page to see the change.
- The page's script tag for Deepnote's client (
https://deepnote.com/static/app-client/v1.js) loads a copy of that client bundled with the extension instead, so the preview works without network access.
inputs() returns the input blocks of the notebook with that ID in the workspace's .deepnote files, as saved on disk, so save the notebook and reload the page to see a change. An ID that no workspace notebook has rejects with Notebook not found.
- The page's other calls to Deepnote reach a local stand-in that does not support them yet:
appData() and run() reject with a message saying so, and VS Code shows a warning the first time the app calls each of them.
- Previewing needs a trusted workspace and the desktop app.
Database integrations
Configure database connections for SQL blocks:
- Open Command Palette
- Run
Deepnote: Manage Integrations
- Add your database credentials (PostgreSQL, BigQuery, etc.)
- Use SQL blocks in your notebooks with the configured integrations
Credentials are securely stored using VS Code's encrypted storage and never leave your machine.
Working with SQL Blocks
SQL blocks allow you to query databases directly from your notebooks:
-- Query your PostgreSQL database
SELECT * FROM users WHERE created_at > '2024-01-01'
Results are displayed as interactive tables that you can explore and export.
Snapshot mode
Snapshot mode gives you a historical, portable record of all notebook executions without polluting your main project files. This makes it easier to work with Git since outputs are stored separately from your source code.
How it works:
- Execution outputs are saved to a
snapshots/ folder alongside your project
- Your main
.deepnote file stays clean (no outputs), making diffs readable
- Each "Run All" execution creates a timestamped snapshot for historical tracking
- Running individual cells updates only the latest snapshot
To enable:
- Open Command Palette (
Cmd+Shift+P or Ctrl+Shift+P)
- Run
Deepnote: Enable Snapshots
Once enabled, snapshots are automatically created when you execute notebooks. You can add the snapshots/ folder to .gitignore to keep outputs local, or commit them to share execution history with your team.
Need help?
Contributing
Want to contribute? Check out our Contributing guide for detailed setup instructions.
Third-party licenses
This project includes the following third-party packages with notable licenses: