Getting Started with JSON-Werkstatt
Your precise tool for JSON data
Quick Installation & Setup
Download the latest stable release (v2.4.1) for macOS, Windows, or Linux. The installer bundles a standalone Electron runtime with zero external dependencies.
Run the executable, accept the default configuration at `~/.config/json-werkstatt`, and launch the workspace. On first boot, the application auto-generates a sample dataset (`payloads/default.json`) and initializes the local SQLite cache for schema validation. If you prefer a CLI workflow, alias `jws` to the binary and run `jws init my-api-project` to scaffold a workspace with preconfigured linting rules and a `.gitignore`.
Interface Tour & First Project
The workspace is divided into three persistent panes: the File Explorer on the left, the Syntax Editor in the center, and the Validation/Preview drawer on the right.
To create your first project, click the `+ New Workspace` button in the explorer gutter. Name it `inventory-sync`, select `Strict Draft-07` as the schema engine, and confirm. The editor will open with a clean `root.json` file. Use the built-in formatter (`Shift+Alt+F`) to auto-indent nested arrays, and run the linter (`Ctrl+L`) to catch trailing commas or mismatched quotes before pushing.
Keyboard Navigation
`Ctrl+P` toggles the command palette, `Cmd+Shift+V` opens the live preview, and `Alt+R` refreshes the schema cache without reloading the UI.
Import & Transform
Drag `.json`, `.jsonl`, or `.geojson` files directly into the editor. Use `Ctrl+Shift+I` to launch the inline transformer, where you can map fields, filter by path, or export to CSV with a single click.
Version Control
JSON-Werkstatt tracks structural changes natively. Hit `Ctrl+Shift+S` to snapshot the current state, then use `Ctrl+Z` or the timeline slider to revert to any previous commit. Sync with Git using the integrated `git.json-werkstatt` plugin.
Once comfortable with the layout, explore the Settings panel (`Ctrl+,`) to customize theme contrast, adjust tab width to 2 or 4 spaces, and enable dark mode for extended review sessions.