Skip to content
MACHHUB MACHHUB MACHHUB
Contribute to this page

MACHHUB Designer (VS Code)

MACHHUB Designer is the official Visual Studio Code extension for MACHHUB application developers. It connects VS Code to a MACHHUB Platform server (local or remote) — the active connection is your MACHHUB Environment — and gives you an in-editor workflow to develop, build, and deploy applications against it.

Get it from the Visual Studio Marketplace — extension ID machhub.machhub-designer.

flowchart LR
  subgraph VS["VS Code"]
    Sidebar["Designer sidebar\n(source + builds + deploy)"]
    Ext["MACHHUB Designer\nproxy server"]
  end
  DevServer["Your dev server\n(SDK requests)"] -- "sdk.Initialize() (no args)" --> Ext
  Ext -- "proxies SDK traffic" --> EDGE["Connected MACHHUB Platform\n(MACHHUB Environment)"]
  Sidebar -- "deploy project" --> EDGE
  • Remote platform connection. Connect VS Code to a MACHHUB Platform server (local or remote), authenticating with a Developer Key; the connected server is your active MACHHUB Environment.
  • Source & build sidebar. A sidebar segments your project’s source and builds and lets you deploy the project to the connected platform without leaving the editor.
  • Dev-server proxy. The extension proxies your dev server’s SDK requests to the connected platform, so await sdk.Initialize() works with no connection config in development. In production the app is hosted on the MACHHUB Platform, so the SDK resolves its connection from the host — manual config is only for self-hosting, a different server/domain, or hardcoding.

The MACHHUB Runtime Connection panel is where you configure and switch environments. A status badge (Connected / disconnected) shows the current state.

MACHHUB Runtime Connection panel with the Configuration Profiles list and connection fields.
The MACHHUB Runtime Connection panel — Configuration Profiles and connection fields.

Each profile is a saved connection. The list supports + New Profile, and per row: Switch (make it active), Rename, and Delete. The active profile is marked (Active). Use profiles to keep separate setups (e.g. nonprod, nonprod/oee-enterprise, site.intellogic) and switch between them.

FieldRequiredNotes
Developer TokenyesA Developer Key (mchx_…) used to authenticate.
Application IDyesTarget application ID of your project (e.g. oee_enterprise).
HTTP API URLnoDefaults to http://localhost:6188.
MQTT URLnoDefaults to ws://localhost:180.
Build Folder PathnoBuild output folder, relative to workspace root. Defaults to build.

The URLs are optional — leave them empty to use the defaults. Actions:

  • Save & Connect — save the profile and connect.
  • Test Connection — verify the settings without switching.
  • Disconnect — drop the active connection.

The panel also exposes the dev server’s logs: View Logs, Clear Logs, Refresh, and Restart Server.

  1. Open the Extensions view in VS Code.
  2. Search for MACHHUB Designer (extension ID machhub.machhub-designer), or install it from the Marketplace listing.
  3. Install it, then reload VS Code.
The MACHHUB Designer listing on the Visual Studio Marketplace.
MACHHUB Designer on the Visual Studio Marketplace.
Connect to a MACHHUB Environment and develop — sdk.Initialize() is proxied to the connected platform.
Deploy the project to MACHHUB from the Designer sidebar.
The Designer sidebar showing source and builds sections, the connected Environment, and the deploy action.
The Designer sidebar — source and builds, the connected MACHHUB Environment, and the deploy action.
  1. Install the extension and open your app project.
  2. (Optional) For AI-assisted development (Claude Code, GitHub Copilot, Antigravity AI, or Cursor), clone the @machhub-dev/skills repo and place the skill folders where your assistant looks for them — see AI Agent Skills.
  3. Connect the Designer to your MACHHUB Platform server, authenticating with a Developer Key — this becomes your active MACHHUB Environment. The proxy uses that key for all SDK traffic it forwards.
  4. Install the SDK: npm install @machhub-dev/sdk-ts.
  5. Initialize with zero-config: await sdk.Initialize(); — the Designer proxy routes your dev server’s SDK requests to the connected platform.
  6. Build your app using the SDK and your framework guide.
  7. Deploy your project to MACHHUB from the Designer sidebar.

Run these from the VS Code Command Palette (Ctrl/Cmd + Shift + P):

CommandWhat it does
MACHHUB: Configure API ConnectionOpen the Runtime Connection panel (profiles, token, URLs).
MACHHUB: Restart Extension ServerRestart the Designer’s local dev/proxy server.
MACHHUB: Focus on Build ViewReveal the Build view.
MACHHUB: Focus on Collections ViewReveal the Collections view.
MACHHUB: Focus on Processes ViewReveal the Processes view.
MACHHUB: Focus on NODE-RED Flows ViewReveal the Node-RED Flows view.
View: Show MACHHUBShow the MACHHUB sidebar container.
View: Toggle MACHHUB ATTRIBUTES DeprecatedToggle the Attributes view.
View: Toggle MACHHUB Flow Palette DeprecatedToggle the Flow Palette view.

For anything not listed here, see the Marketplace listing.