Run and preview corbase documentation
without leaving the editor — the OpenAPI surface, the PostgreSQL schema beneath
it, and the guides alongside both.
A project is any folder holding a corbase.config.js — that is the whole
contract, and this extension makes it true from the editor.
What it does
Finds projects — every folder in the workspace with a corbase.config.*
appears in the corbase view in the activity bar. Add folders detection misses
with the corbase.scopes setting.
Runs the dev server — one click per project, with live status. Output goes
to the corbase channel.
Shows the documentation in a tab — a webview beside your code, opening
automatically once the server is ready. Cmd+R reloads it.
Creates a config — corbase: Create corbase.config.js, also on a folder's
explorer context menu. It pre-fills any specs already in the folder.
Builds the static site — corbase: Build Static Site.
Commands
Command
Description
corbase: Run
Start the dev server for a project
corbase: Stop
Stop it
corbase: Open Documentation
Show the docs in an editor tab
corbase: Open in Browser
Same, in your browser
corbase: Reload Preview
Reload the tab (Cmd+R while focused)
corbase: Create corbase.config.js
Scaffold a config
corbase: Build Static Site
Write the static site
corbase: Show Output
Open the output channel
Settings
Setting
Description
corbase.scopes
Extra project folders, workspace-relative or absolute
corbase.openPreviewOnRun
Open the tab automatically when the server is ready (default: on)
Which corbase it runs
The project's own install is preferred, so documentation is built by the version
the project pins. A folder holding nothing but a config falls back to
npx corbase.