JSONPath Notebook
for Visual Studio Code

A Visual Studio Code Extension for running JSONPath queries inside Notebooks (also known as Jupyter Notebooks).

Features

• Quickly run JSONPath queries on your JSON files
• Annotate and organize queries using Markdown cells
• allows you to use different JSON input files for each cell
• open query result in new document to save or further edit
• input file (context) is remembered by each cell and stored in the notebook file
• store and share notebook files .jsonpath-notebook

Installation

Install the extension through the VS Code marketplace. https://marketplace.visualstudio.com/items?itemName=tschranz.jsonpath-notebook or just search for JSONPath Notebook inside the Extension Pane.

If you prefer not use the Microsoft Marketplace you can also install the extension directly:

1. Go to the Releases page of the Repository and download the latest .vsix file.
2. Install the extension by either running the VS Code command Developer: Install Extension from Location and selecting the .visx file or by running the command code --install-extension <filename>.visx

Usage

Creating a new Notebook

After installation a popup should appear, asking you to create a new notebook.

You can also create a new notebook by using the command JSONPath Notebook: Open new Notebook or creating a file with the .jsonpath-notebook ending.

Switching input file (context)

On first execution of a cell the input file is determined as follows

• by default the JSON file opened in the editor will be used
  • if there is more than one JSON file opened in the editor, a popup appears asking to select a file
  • there is also an option in this popup to select a file from the file system
• if there is no JSON file opened, a popup appears asking to select a file

The chosen context (input file) gets saved inside the notebook (per cell) and can be changed any time by clicking on the corresponding button in the lower right of the cell.

Open output

The result of a query can be opened in a new file by clicking the button Open output in new tab in the lower left of the cell.

Markdown support

JSONPath Notebook supports Markdown formatted cells. To add a new Markdown cell press the button + Markdown or run the command Notebook: Insert Markdown Cell Above/Below. For an introduction to the Markdown syntax see Github Markdown Guide.

Extension Settings

WIP

Release Notes

See Changelog.md

Issue Reporting and Feature Requests

Found a bug? Have a feature request? Reach out on our GitHub Issues page.

JSONPath engines used

• Default: https://github.com/brunerd/jsonpath
• more engine options coming soon

Note: Because the standardization of JSONPath is still ongoing, current engine implementations differ in syntax and functionality.