The Hub
Everything in Dobermann happens in one editor tab: the Hub. Click the Dobermann icon in the VS Code Activity Bar and the Hub opens; the VS Code sidebar closes, because the Hub has its own navigation. By default the Hub also opens itself when VS Code starts (the dbmn.preloadHubOnStartup setting), on Home.
The Hub has four parts, left to right and top to bottom:
| Part | What it is |
|---|---|
| Header | The DBMN mark, the environment selector, and the activity chip |
| Rail | Sections: Environments, API Catalogue, History, Import, Export, and pinned at the bottom Account and Settings |
| List panel | Slides out over the tabs when you click a rail item: your endpoints, your environments, your past runs |
| Tabs | Where things open: endpoint editors, environment editors, Run Batch, and the Console. With no tab open, Home |
Header
Environment selector
The selector in the header shows which environment every request will go to. It reads No environment until you pick one. Click it and choose from the list; environments typed Production are shown in red, and the whole header turns red while one is active, so there is no mistaking what you are connected to. See Environments — Environment Type.
If an environment’s token carries more than one organisation, each organisation is a sub-row under it. Pick one and the selector reads Environment · Org; until you do it reads (pick org).
The selector is the main way to set the active environment. The other is the Set as Active button in the footer of a saved environment’s editor.
Signed out of DBMN, the header shows Sign in to DBMN where the selector was. It opens the same sign-in as Account: enter your email, and a new address is registered as it signs in. The selector comes back once you are signed in.
Activity chip
The chip on the right of the header reads Idle, N running, N running · N queued, N paused, or Recent failure. Click it for a drawer listing what is running, what is queued, the newest paused batches, and what finished recently. Click an entry to open its Console.
Help mode
Every control in DBMN links to its section of these docs. Click the help button at the right end of the header, or press ? anywhere you are not typing. A banner at the top reads Help mode while it is on. It covers the Hub and every open tab: each documented control gets a dotted outline, and clicking one opens its docs instead of doing its job. Nothing else runs while help mode is on. Press Esc, or the help button again, to leave. See Help Mode.
API Catalogue
Your endpoints. Grouped by the URL path they share by default; Settings → API Catalogue → Group by offers URL, System, Method or None (flat).
| Control | What it does |
|---|---|
| Search across everything… | Filters by name, method, path, description and tags as you type |
| Filters | Narrow the list by System, Method and Tags. The button shows how many filters are on; × clears them all |
| Add Endpoint | Opens a blank endpoint editor in a new tab |
| New Endpoint from Clipboard | Opens a new endpoint filled from an endpoint a teammate shared — see Sharing Endpoints |
| Select | Turns on checkboxes for bulk actions on the selection. Delete names what goes and asks first; their History is kept. Export writes them to a .dbmn.zip. Update sets their System, adds tags, and removes any of the tags they carry, all at once |
| Recent | The five endpoints you last saved or ran, pinned above the groups. Turn it off in Settings |
Each row shows the method, name and path, with Run API on the right. Endpoints with {{template variables}} also show Run Batch. Both read Sign in to run until you are signed in. Click the row to open the endpoint in a tab.
Endpoints are not filed in folders. They carry tags, and the catalogue is grouped for you. See Endpoints — Tags.
Environments
Your environments, each with its base URL. Click a row to open it in a tab. Add Environment opens a blank environment editor. The paw print marks the active environment; to change it, use the header selector.
See Environments.
History
Every run, single or batch, newest first. Each row shows its status, the endpoint and path, and a line with the method, how long ago, the environment, the HTTP status and the run time. Click a row to reopen its Console with full results.
| Control | What it does |
|---|---|
| Search endpoint, path, status, body content… | Filters the list as you type, including on what was sent and received |
| Select | Turns on checkboxes; the red Delete removes the selected runs and their files. Settings → UI can ask you to confirm first |
| Settings → Transactions → Show | Current Environment or All Environments |
| Settings → Transactions → Group by | Date, Endpoint, Environment, Status or None (flat) |
Right-click a row for the actions its Console footer would show for that state: Pause a running batch, Resume a paused, stopped or cancelled one, Cancel a queued batch or a single request still in flight, Delete, and Open. Reprocess… and Re-run open the Console, where their options are. See Console and Batch Reprocessing.
Import and Export
Import and Export each open as a tab. Export writes your chosen endpoints and environments to one .dbmn.zip; Import reads one back, or a Postman collection. See Import/Export.
Account
Sign in to DBMN, see your licence and weekly usage, and find Puppy School & Badges: the five-lesson course on The Training Ground, with the badges you have earned. Start Puppy School opens the course at dbmn.io/puppy-school in your browser; it reads Continue or Revisit once you have begun. See Environments — DBMN authentication for what signing in gives your environments.
Settings
| Panel | Settings |
|---|---|
| API Catalogue | Show Current Environment (only endpoints in the active environment’s System) or All Systems. Group by. Recent on or off. Manage Tags… to rename, merge or delete tags across every endpoint |
| Transactions | Show and Group by for History |
| Execution | Auto-open console on completion. Treat network errors as critical: timeouts, DNS and connection failures stop a batch at once, whatever its error handling. Critical HTTP codes, default 401, 403, which also stop a batch at once. Max CSV rows for batch uploads |
| UI | Confirm transaction deletion |
| Workspace | The DBMN workspace folder, with Open folder and Change folder…, and the path of the executions database. See Your Data |
| Systems | Your Systems, and Add System |
Systems
A System is a short name for one API you work with: wms, erp, crm. Environments and endpoints both carry one, and it is how the catalogue knows which endpoints belong with the active environment. A new endpoint inherits the System of the active environment. Names are lowercase letters and digits, up to 16 characters. Pick one in the System field of either editor, or create one there with + Add new System…. To change many endpoints at once, tick them in Select mode and click Update.
Home
With no tab open, the tab area shows Home, and the Hub opens on it every time VS Code starts:
- Pick up where you left off lists the tabs you had open last time. Re-open brings them back; the Hub does not reopen them by itself.
- Puppy School shows the five lessons and the badges you have earned. Start Puppy School (or Continue) opens the course on dbmn.io. Once you graduate, it shows your graduate badge.
- Quick start: Add Endpoint, New Endpoint from Clipboard, Add Environment and Import.
- What’s new counts the new features and fixes since the version you used before, with a link to the Changelog.
- This week shows your API calls, batches, rows processed and run time, while you are signed in.
- A tip, changing every 15 seconds.
The rail’s names sit beside its icons on Home. Everywhere else the rail is icons only; hover one for its name.
List panel
Click Environments, API Catalogue or History in the rail and its list slides out over the tabs. Click the same item again to close it, or another to switch lists. The tabs underneath keep their width.
The panel closes by itself when you open something from it: an endpoint, an environment, a run, Add Endpoint. Searching, filters, Select and collapsing a group leave it open. Esc, or a click on the dimmed tabs, also closes it. Drag its right edge to make it wider; the Hub remembers the width.
Tabs
Endpoints, environments, Run Batch and the Console open as tabs in the Hub’s tab area, not as separate VS Code editors. Each opens once; clicking it again brings its tab forward.
- Drag tabs to reorder them.
- Close all appears once two or more tabs are open. Anything unsaved stays open: an edited endpoint or environment, and a Run Batch holding data you haven’t run. The rest close, Consoles included; a running batch carries on, and History opens its Console again.
- Ctrl+W (Cmd+W on Mac) closes the active tab while the Hub has focus. A tab with unsaved changes asks Save / Discard / Cancel first; a Run Batch holding data asks Close and lose it or Keep open.
- Full-window editors (a request body, a Raw pane, a request on Run Batch’s Review step) keep the footer as a thin strip at the bottom; hover it to reach the buttons. Esc exits.
Related Topics
- Getting Started — Your first environment, endpoint and run
- Environments — Base URL, authentication, concurrency
- Endpoints — The endpoint editor
- Console — Results, live progress, export
- Shortcuts — Keyboard shortcuts